Skip to content

Commit 33fdecb

Browse files
committed
Document Nix files added to the repo
1 parent 54bdbe8 commit 33fdecb

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/target
22

3+
# Devenv files, to handle the development shell defined by the flake
34
.devenv/

docs/maintainers-guide.md

+7
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
fastNLO tables to PineAPPL grids
3434
- `pineappl_py`: the crate that builds PineAPPL's Python interface
3535
- `xtask`: crate for [cargo-xtask] commands
36+
- `.envrc`: [direnv] hooks (mainly enable Nix shell)
3637
- `.gitignore`: PineAPPL's Git ignore rules
3738
- `.readthedocs.yml`: configuration for PineAPPL's [Read-the-Docs] Python
3839
interface documentation
@@ -44,6 +45,9 @@
4445
- `README.md`: PineAPPL's repository README file. This file also serves as the
4546
homepage of [PineAPPL's website]
4647
- `_config.yml`: configuration file for PineAPPL's Github-pages website
48+
- `flake.lock`: Nix [flake lock file]
49+
- `flake.nix`: Nix [flake], which tracks cross-language dependencies to define a
50+
reproducible build for the PineAPPL packages, and a suitable development shell
4751
- `install-capi.sh`: POSIX-compliant shell script to download and install
4852
PineAPPL's pre-built CAPI
4953

@@ -57,6 +61,9 @@
5761
[lock file]: https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
5862
[license v3]: https://www.gnu.org/licenses/gpl-3.0.en.html
5963
[PineAPPL's website]: https://nnpdf.github.io/pineappl/
64+
[flake]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-format
65+
[flake lock file]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#lock-files
66+
[direnv]: https://direnv.net/
6067

6168
## Abbreviations and terminology
6269

0 commit comments

Comments
 (0)