diff --git a/docs/README.md b/docs/README.md index fa2dba1f2ab8d9804288fcb980038d3721bf55bf..571f755fcf40e00f8d849eeb6cee877121756fe1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,6 +10,20 @@ The rest of this documentation will assume you already have Zig installed. 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`. +## Download +You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source. + +### Build Zigmod from source +Assuming you have Zig master `0.8.0-dev.1127+6a5a6386c` installed, +``` +$ git clone https://github.com/nektro/zigmod --recursive +$ cd zigmod +$ zig build -Dbootstrap +$ ./zig-cache/bin/zigmod fetch +$ zig build +$ ./zig-cache/bin/zigmod +``` + ## Getting Started For a full command reference you can check [here](./commands/). @@ -24,3 +38,11 @@ $ zigmod init ## Principles 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). + +## Contact +- https://github.com/nektro/zigmod/issues +- hello@nektro.net +- https://twitter.com/nektro + +## License +MIT