diff --git a/README.md b/README.md index fbf0ad7..3a9673f 100644 --- a/README.md +++ b/README.md @@ -98,24 +98,9 @@ env ALL_TESTS=yes cabal v2-test env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test ``` -## Entering the HNix REPL +### Building -Enter REPL: -``` -hnix --repl -``` - -To evaluate an expression and make it available in the REPL as the `input` variable use: -``` -hnix --eval -E '(import {}).pkgs.hello' --repl -``` - -Use the `:help` command for a list of all available REPL commands. - - -## Building - -### With benchmarks +#### With benchmarks To run benchmarks: @@ -123,7 +108,7 @@ To run benchmarks: cabal v2-bench ``` -### With profiling +#### With profiling To build `hnix` with profiling enabled: @@ -132,7 +117,7 @@ cabal v2-configure --enable-tests --enable-profiling --flags=profiling cabal v2-run hnix -- +RTS -p ``` -### With full debug info +#### With full debug info To build `hnix` for debugging, with full tracing output and stack traces: @@ -151,6 +136,21 @@ cabal v2-run hnix -- --help (`--` is for separation between `cabal` & `hnix` args) +## Entering the HNix REPL + +Enter REPL: +``` +hnix --repl +``` + +To evaluate an expression and make it available in the REPL as the `input` variable use: +``` +hnix --eval -E '(import {}).pkgs.hello' --repl +``` + +Use the `:help` command for a list of all available REPL commands. + + ## Contributing 1. If something in the [quests](https://github.com/haskell-nix/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) looks interesting, look through the thread and leave a comment taking it, to let others know you're working on it.