Skip to content

Commit

Permalink
Document nix devshells in README
Browse files Browse the repository at this point in the history
This only explains how to obtain different rust toolchains using direnv
or `nix develop`, since flake checks are currently limited by
redis/docker issue.
  • Loading branch information
nothingmuch committed Jan 3, 2025
1 parent e932911 commit e3e5f8d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,18 @@ cargo update -p zstd-sys --precise 2.0.8+zstd.1.5.5

## Contributing

### Nix Development Shells

Where nix is available (NixOS or
[otherwise](https://determinate.systems/nix-installer/)), development shells are provided.

The default shell uses rust nightly, and can be activated manually using `nix
develop` in the project root, or automatically with
[direnv](https://determinate.systems/posts/nix-direnv/).

To use the minimal supported version, use `nix develop .#msrv`. `.#stable` is
also provided.

### Testing

We test a few different features combinations in CI. To run all of the combinations locally, have Docker running and run `contrib/test.sh`.
Expand Down

0 comments on commit e3e5f8d

Please sign in to comment.