From ff404dbbbb372706e3a49104b61b172a3fa62132 Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Sun, 25 Feb 2024 15:10:21 +0100 Subject: [PATCH] Document Nix files added to the repo --- .gitignore | 1 + docs/maintainers-guide.md | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/.gitignore b/.gitignore index c305a71e..cd52e691 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /target +# Devenv files, to handle the development shell defined by the flake .devenv/ diff --git a/docs/maintainers-guide.md b/docs/maintainers-guide.md index cd31d69c..c9f493df 100644 --- a/docs/maintainers-guide.md +++ b/docs/maintainers-guide.md @@ -33,6 +33,7 @@ fastNLO tables to PineAPPL grids - `pineappl_py`: the crate that builds PineAPPL's Python interface - `xtask`: crate for [cargo-xtask] commands +- `.envrc`: [direnv] hooks (mainly enable Nix shell) - `.gitignore`: PineAPPL's Git ignore rules - `.readthedocs.yml`: configuration for PineAPPL's [Read-the-Docs] Python interface documentation @@ -44,6 +45,9 @@ - `README.md`: PineAPPL's repository README file. This file also serves as the homepage of [PineAPPL's website] - `_config.yml`: configuration file for PineAPPL's Github-pages website +- `flake.lock`: Nix [flake lock file] +- `flake.nix`: Nix [flake], which tracks cross-language dependencies to define a + reproducible build for the PineAPPL packages, and a suitable development shell - `install-capi.sh`: POSIX-compliant shell script to download and install PineAPPL's pre-built CAPI @@ -57,6 +61,9 @@ [lock file]: https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html [license v3]: https://www.gnu.org/licenses/gpl-3.0.en.html [PineAPPL's website]: https://nnpdf.github.io/pineappl/ +[flake]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-format +[flake lock file]: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#lock-files +[direnv]: https://direnv.net/ ## Abbreviations and terminology