max/lean4-htt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

doc: add note about staging flake.nix (#411)

Browse source 
If you don't make flake.nix visible to Git, nix build etc. won't work. Add a command that adds the file to the Index and a note explaining why.
This commit is contained in:
Paul Brinkmeier 2021-04-15 18:45:22 +02:00 • committed by GitHub
parent 32fd82efc2
commit c1623add68
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/setup.md
View file

@ -75,8 +75,10 @@ Note: Your system Nix might print warnings about not knowing some of the setting
From a Lean shell, run
```bash
$ nix flake new mypkg -t github:leanprover/lean4
$ cd mypkg && git init && git add flake.nix
```
to create a new Lean package in directory `mypkg` using the latest commit of Lean 4.
Note that Nix Flakes will not recognize your `flake.nix` file unless it is visible to Git.
Such packages follow the same directory layout as described in the basic setup above, except for a `leanpkg.toml` replaced by a `flake.nix` file set up so you can run Nix commands on it, for example:
```bash
$ nix build # build package and all dependencies