1# Zigmod Documentation
2
3Zigmod is a prototype package manager for the Zig programming language.
4
5You can learn more about Zig here:
6- https://ziglang.org/
7- https://github.com/ziglang/zig
8
9The rest of this documentation will assume you already have Zig installed.
10
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.
12
13The earliest Zig release this Zigmod was verified to work with is `0.16.0`.
14
15## Download
16You may download a precompiled binary from https://github.com/nektro/zigmod/releases or build the project from source.
17
18### Build Zigmod from source
19```
20$ git clone https://github.com/nektro/zigmod
21$ cd zigmod
22$ zig build -j1
23```
24
25## Getting Started
26
27Check here for the [full command reference](./commands/).
28
29Check here for the [`zigmod.yml` reference](./zig.mod.md).
30
31Check here for the [`deps.zig` reference](./deps.zig.md).
32
33There is now also a tutorial-style guide that goes over various use cases that Zigmod provides and caters to. It is [available here](tutorial.md).
34
35### A new project
36Create a new directory for your project and run these commands to get started:
37```
38$ git init
39$ zig init-exe
40$ zigmod init
41```
42
43You will also want to add `/.zigmod` and `/deps.zig` to your `.gitignore`.
44
45Then 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).
46
47## Principles
48Zigmod 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).
49
50## Contact
51- https://github.com/nektro/zigmod/issues
52- hello@nektro.net
53- https://twitter.com/nektro
54
55## License
56MIT