authorgravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-02-20 21:15:34 -08:00
committergravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-02-20 21:15:34 -08:00
log178d6e813e4a1e4a0a26ab060917e540523cd7af
treea6be02781112e4aec982674afca74f1ded13e41d
parent437cf37bd4bec7588ac25d4d54833f4809b8a9ff

docs- copy download instructions and license info over to docs

1 files changed, 22 insertions(+), 0 deletions(-)

docs/README.md+22
...@@ -10,6 +10,20 @@ The rest of this documentation will assume you already have Zig installed....@@ -10,6 +10,20 @@ The rest of this documentation will assume you already have Zig installed.
1010
11As 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`.11As 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`.
1212
13## Download
14You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source.
15
16### Build Zigmod from source
17Assuming 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## Getting Started27## Getting Started
1428
15For a full command reference you can check [here](./commands/).29For a full command reference you can check [here](./commands/).
...@@ -24,3 +38,11 @@ $ zigmod init...@@ -24,3 +38,11 @@ $ zigmod init
2438
25## Principles39## Principles
26Zigmod 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).40Zigmod 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
48MIT