Skip to content

Commit

Permalink
Document Nix files added to the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
alecandido committed Feb 25, 2024
1 parent 21bc5d4 commit ce0150b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/target

# Devenv files, to handle the development shell defined by the flake
.devenv/
7 changes: 7 additions & 0 deletions docs/maintainers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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

Expand Down

0 comments on commit ce0150b

Please sign in to comment.