zig-overlay/README.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

# Nix Flake for Zig
This repository is a Nix flake packaging the [Zig](https://ziglang.com)
compiler. The flake mirrors the binaries built officially by Zig and
does not build them from source.
2022-08-22 19:10:14 -07:00
This repository is meant to be consumed primarily as a flake but the
`default.nix` can also be imported directly by non-flakes, too.
2022-08-22 19:10:14 -07:00
The flake outputs are documented in `flake.nix` but an overview:
* Default package and "app" is the latest released version
* `packages.<version>` for a tagged release
* `packages.master.<date>` for a nightly release
* `packages.master.latest` for the latest nightly release
## Usage
### Flake Support
In your `flake.nix` file:
```nix
{
inputs.zig.url = "github:mitchellh/zig-overlay";
2022-08-22 19:10:14 -07:00
outputs = { self, zig, ... }: {
...
};
}
```
In a shell:
```sh
2022-08-22 19:10:14 -07:00
# run the latest released version
$ nix run 'github:mitchellh/zig-overlay'
# open a shell with master version dated 2021-02-13 (oldest version available)
$ nix shell 'github:mitchellh/zig-overlay#master."2021-02-13"'
# open a shell with latest master version
$ nix shell 'github:mitchellh/zig-overlay#master.latest'
```
## Thanks
This repository is originally hosted by the username `arqv`. This user
and repository disappeared at some point and I had a local checkout so
I've forked it, modified it, and reuploaded it here.