jussi/zig-overlay
1
0
Fork 0
mirror of https://github.com/mitchellh/zig-overlay.git synced 2025-02-05 17:02:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

update README

Browse source
This commit is contained in:
Mitchell Hashimoto 2022-08-22 19:10:14 -07:00
parent f0c4a8c91b
commit de6bcff2cf
No known key found for this signature in database
GPG key ID: 523D5DC389D273BC
1 changed files with 10 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -4,12 +4,15 @@ This repository is a Nix flake packaging the [Zig](https://ziglang.com)
compiler. The flake mirrors the binaries built officially by Zig and compiler. The flake mirrors the binaries built officially by Zig and
does not build them from source. does not build them from source.
Provided packages: This repository is meant to be consumed primarily as a flake but the
`default.nix` can also be imported directly by non-flakes, too.
* Nightly versions updated daily (`.master.<date>`), starting from version The flake outputs are documented in `flake.nix` but an overview:
`0.8.0-dev.1140+9270aae07` dated 2021-02-13, and latest master
(`.master.latest`) for the sake of convenience. * Default package and "app" is the latest released version
* Release versions. * `packages.<version>` for a tagged release
* `packages.master.<date>` for a nightly release
* `packages.master.latest` for the latest nightly release
## Usage ## Usage
@ -20,6 +23,7 @@ In your `flake.nix` file:
```nix ```nix
{ {
inputs.zig.url = "github:mitchellh/zig-overlay"; inputs.zig.url = "github:mitchellh/zig-overlay";
outputs = { self, zig, ... }: { outputs = { self, zig, ... }: {
... ...
}; };
@ -29,7 +33,7 @@ In your `flake.nix` file:
In a shell: In a shell:
```sh ```sh
# run the latest version # run the latest released version
$ nix run 'github:mitchellh/zig-overlay' $ nix run 'github:mitchellh/zig-overlay'
# open a shell with master version dated 2021-02-13 (oldest version available) # open a shell with master version dated 2021-02-13 (oldest version available)
$ nix shell 'github:mitchellh/zig-overlay#master."2021-02-13"' $ nix shell 'github:mitchellh/zig-overlay#master."2021-02-13"'
@ -37,25 +41,6 @@ $ nix shell 'github:mitchellh/zig-overlay#master."2021-02-13"'
$ nix shell 'github:mitchellh/zig-overlay#master.latest' $ nix shell 'github:mitchellh/zig-overlay#master.latest'
``` ```
### No Flake Support
Import in your project as you would normally (`pkgs.fetchFromGitHub` or
`builtins.fetchgit`). The `default.nix` exposes a `pkgs` argument for possible
pinning of the nixpkgs repository, and a `system` argument which defaults to
`builtins.currentSystem`.
```nix
# It is a good idea to use an exact commit in place of 'main' here.
let
zigf = fetchTarball "https://github.com/mitchellh/zig-overlay/archive/main.tar.gz"
in
# If you're using home-manager
home.packages = [ zigf.master.latest ]; # or any available version
# If you're using NixOS
users.user.<username>.packages = [ zigf.master.latest ]; # or any available version
```
## Thanks ## Thanks
This repository is originally hosted by the username `arqv`. This user This repository is originally hosted by the username `arqv`. This user