91d8b86b39
This adds a new Website/Docs for Snix, using Thulite / Doks, which is mostly hugo and a bit of npm. Change-Id: Iea10d4068fa783ec0ddd6bcaba5c8d92b1a1168f
2 KiB
| title | slug | description | summary | date | lastmod | draft | weight | toc |
|---|---|---|---|---|---|---|---|---|
| Building Snix | building | 2025-03-14T14:14:35+01:00 | 2025-03-14T14:14:35+01:00 | false | 11 | true |
This document describes how to build the project locally, both for interactive development as well as referring to it from Nix code (for example, to run one of its binaries on your machine).
{{}} Please check the [Contribution Guide]({{< relref "contributing" >}}) on how to contribute after following this guide. {{}}
Requirements
- Ensure you have Direnv installed and hooked into your shell.
- Ensure you have Nix installed.
Getting the sources
Snix is hosted in its own Forgejo instance, hosted on git.snix.dev, and a (read-only) mirror on GitHub.
Check out the source code as follows:
$ git clone https://git.snix.dev/snix-project/snix.git
Interactive development
$ direnv allow
$ mg shell //snix:shell
This provides all the necessary tools and dependencies to interactively build
the source code, using cargo build etc.
Building only
It is also possible to build the different Snix crates with Nix, in which you don't need to enter the shell. From the root of the repository, you can build as follows:
$ nix-build -A snix.cli
Alternatively, you can use the mg wrapper from anywhere in the repository (requires the direnv setup from above):
$ mg build //snix:cli
This uses crate2nix to build each crate dependency individually.
Checkout the [Component Overview]({{< ref "/docs/components/overview" >}}) to learn more about the project structure.