authorgravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-05-07 20:47:29 -07:00
committergravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-05-07 20:47:29 -07:00
log8e60e87abb390e67355abcac566dced0fb481551
treea64da9019b394808223b3c822d925ffd9a646c15
parent5b1f555264a3a5cc27f48d369e18ff166fd2a9b8

docs- clarify sections to be easier to follow along

2 files changed, 12 insertions(+), 2 deletions(-)

docs/README.md+11-1
...@@ -14,12 +14,18 @@ As Zig is still in development itself, if you plan to contribute to Zigmod you w...@@ -14,12 +14,18 @@ As Zig is still in development itself, if you plan to contribute to Zigmod you w
14You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source.14You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source.
1515
16### Build Zigmod from source16### Build Zigmod from source
17Assuming you have Zig master installed,17Zigmod partially uses itself to manage dependencies but can be bootstrapped with the 2 (two) included Git submodules. The first step will generate a build of Zigmod that only has the `fetch` command. This binary can then be used to grab the rest of the dependencies and generate a full build.
18
18```19```
19$ git clone https://github.com/nektro/zigmod --recursive20$ git clone https://github.com/nektro/zigmod --recursive
20$ cd zigmod21$ cd zigmod
21$ zig build -Dbootstrap22$ zig build -Dbootstrap
22$ ./zig-out/bin/zigmod fetch23$ ./zig-out/bin/zigmod fetch
24```
25
26Now that we made our bootstrap build and have the rest of our dependencies, we can build as normal.
27
28```
23$ zig build29$ zig build
24$ ./zig-out/bin/zigmod30$ ./zig-out/bin/zigmod
25```31```
...@@ -40,6 +46,10 @@ $ zig init-exe...@@ -40,6 +46,10 @@ $ zig init-exe
40$ zigmod init46$ zigmod init
41```47```
4248
49You will also want to add `/.zigmod` and `/deps.zig` to your `.gitignore`.
50
51Then run `zigmod fetch`. After that you will be ready to integrate Zigmod with your existing `build.zig` which you can learn how to do [here](commands/fetch.md).
52
43## Principles53## Principles
44Zigmod is but a prototype and not the official Zig package manager. As such I wanted to lay out some of the guiding principles learned/used when making the project. You can find that document [here](./principles.md).54Zigmod is but a prototype and not the official Zig package manager. As such I wanted to lay out some of the guiding principles learned/used when making the project. You can find that document [here](./principles.md).
4555
docs/commands/fetch.md+1-1
...@@ -3,7 +3,7 @@...@@ -3,7 +3,7 @@
3zigmod fetch3zigmod fetch
4```4```
55
6- This command takes no parameters and will generate a `deps.zig` in the root of your project.6- This command takes no parameters and will generate a `deps.zig` in the root of your project. This is the file that you will then import into your `build.zig` to automatically add all the necessary packages and (any) C code that may be in your dependencies.
7- `deps.zig` is not typically checked into your source control.7- `deps.zig` is not typically checked into your source control.
88
9For a full reference on the fields available in `deps.zig` you can check [here](../deps.zig.md).9For a full reference on the fields available in `deps.zig` you can check [here](../deps.zig.md).