Skip to content

Commit

Permalink
add note on development shell with Nix
Browse files Browse the repository at this point in the history
  • Loading branch information
vreuter committed Jun 25, 2024
1 parent 9759ad1 commit f488cbc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ This project builds using [sbt][sbt].
* build the documentation: `sbt ;documentation/mdoc; makeSite`
* run benchmarks (you can provide [JMH][jmh] arguments in the end): `sbt benchmarksJVM/jmh:run`

If you don't already have `sbt`, or if you'd like an isolated environment for development on this project, you may use the Nix shell.
For that, you just need to have the [Nix package manager][nix] installed on your machine, and then from this project's root folder run `nix-shell`.

[fs2]: https://fs2.io/
[sbt]: https://scala-sbt.org
[jmh]: https://openjdk.java.net/projects/code-tools/jmh/
[website]: https://fs2-data.gnieh.org
[nix]: https://nixos.org/download/

0 comments on commit f488cbc

Please sign in to comment.