| ... | ... | @@ -10,6 +10,20 @@ The rest of this documentation will assume you already have Zig installed. |
| 10 | 10 | |
| 11 | 11 | As Zig is still in development itself, if you plan to contribute to Zigmod you will need a master download of Zig. Those can be obtained from https://ziglang.org/download/#release-master. The most recent release Zigmod was verified to work with is `0.8.0-dev.1127+6a5a6386c`. |
| 12 | 12 | |
| 13 | ## Download |
| 14 | You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source. |
| 15 | |
| 16 | ### Build Zigmod from source |
| 17 | Assuming you have Zig master `0.8.0-dev.1127+6a5a6386c` installed, |
| 18 | ``` |
| 19 | $ git clone https://github.com/nektro/zigmod --recursive |
| 20 | $ cd zigmod |
| 21 | $ zig build -Dbootstrap |
| 22 | $ ./zig-cache/bin/zigmod fetch |
| 23 | $ zig build |
| 24 | $ ./zig-cache/bin/zigmod |
| 25 | ``` |
| 26 | |
| 13 | 27 | ## Getting Started |
| 14 | 28 | |
| 15 | 29 | For a full command reference you can check [here](./commands/). |
| ... | ... | @@ -24,3 +38,11 @@ $ zigmod init |
| 24 | 38 | |
| 25 | 39 | ## Principles |
| 26 | 40 | Zigmod 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 documen [here](./principles.md). |
| 41 | |
| 42 | ## Contact |
| 43 | - https://github.com/nektro/zigmod/issues |
| 44 | - hello@nektro.net |
| 45 | - https://twitter.com/nektro |
| 46 | |
| 47 | ## License |
| 48 | MIT |
Meghan Denny <hello@nektro.net> 2021-02-20 21:15:34 -08:00