README: unify shell entries: rm $ from shell entries
This commit is contained in:
parent
d8f38bcece
commit
18b54986b1
55
README.md
55
README.md
|
@ -18,18 +18,17 @@ for interacting with store paths, until `hnix-store` is ready.
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git clone --recursive https://github.com/haskell-nix/hnix.git
|
git clone --recursive https://github.com/haskell-nix/hnix.git
|
||||||
...
|
cd hnix
|
||||||
$ cd hnix
|
nix-shell
|
||||||
$ nix-shell
|
cabal v2-configure --enable-tests
|
||||||
$ cabal v2-configure --enable-tests
|
cabal v2-build
|
||||||
$ cabal v2-build
|
cabal v2-test
|
||||||
$ cabal v2-test
|
|
||||||
# To run all of the tests, which takes up to a minute:
|
# To run all of the tests, which takes up to a minute:
|
||||||
$ env ALL_TESTS=yes cabal v2-test
|
env ALL_TESTS=yes cabal v2-test
|
||||||
# To run only specific tests (see `tests/Main.hs` for a list)
|
# To run only specific tests (see `tests/Main.hs` for a list)
|
||||||
$ env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test
|
env NIXPKGS_TESTS=yes PRETTY_TESTS=1 cabal v2-test
|
||||||
$ ./dist/build/hnix/hnix --help
|
./dist/build/hnix/hnix --help
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using the REPL
|
## Using the REPL
|
||||||
|
@ -55,10 +54,10 @@ To build `hnix` for debugging, and with full tracing output and stack traces,
|
||||||
use:
|
use:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ nix-shell
|
nix-shell
|
||||||
$ cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
|
cabal v2-configure --enable-tests --enable-profiling --flags=profiling --flags=tracing
|
||||||
$ cabal v2-build
|
cabal v2-build
|
||||||
$ ./dist/build/hnix/hnix -v5 --trace <args> +RTS -xc
|
./dist/build/hnix/hnix -v5 --trace <args> +RTS -xc
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that this will run quite slowly, but will give the most information as to
|
Note that this will run quite slowly, but will give the most information as to
|
||||||
|
@ -69,10 +68,10 @@ what might potentially be going wrong during parsing or evaluation.
|
||||||
To build `hnix` with benchmarks enabled:
|
To build `hnix` with benchmarks enabled:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ nix-shell --arg doBenchmarks true
|
nix-shell
|
||||||
$ cabal v2-configure --enable-tests --enable-benchmarks
|
cabal v2-configure --enable-tests --enable-benchmarks
|
||||||
$ cabal v2-build
|
cabal v2-build
|
||||||
$ cabal v2-bench
|
cabal v2-bench
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building with profiling enabled
|
## Building with profiling enabled
|
||||||
|
@ -80,10 +79,10 @@ $ cabal v2-bench
|
||||||
To build `hnix` with profiling enabled:
|
To build `hnix` with profiling enabled:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ nix-shell
|
nix-shell
|
||||||
$ cabal v2-configure --enable-tests --enable-profiling --flags=profiling
|
cabal v2-configure --enable-tests --enable-profiling --flags=profiling
|
||||||
$ cabal v2-build
|
cabal v2-build
|
||||||
$ ./dist/build/hnix/hnix <args> +RTS -p
|
./dist/build/hnix/hnix <args> +RTS -p
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building with GHCJS
|
## Building with GHCJS
|
||||||
|
@ -91,7 +90,7 @@ $ ./dist/build/hnix/hnix <args> +RTS -p
|
||||||
From the project root directory, run:
|
From the project root directory, run:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ NIX_CONF_DIR=$PWD/ghcjs nix-build ghcjs
|
NIX_CONF_DIR=$PWD/ghcjs nix-build ghcjs
|
||||||
```
|
```
|
||||||
|
|
||||||
This will build an `hnix` library that can be linked to your GHCJS
|
This will build an `hnix` library that can be linked to your GHCJS
|
||||||
|
@ -103,8 +102,8 @@ If you're on macOS, you can use the binary cache at Cachix to avoid building
|
||||||
the specific dependencies used by hnix. Just use these commands:
|
the specific dependencies used by hnix. Just use these commands:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/db557aab7b690f5e0e3348459f2e4dc8fd0d9298
|
nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/db557aab7b690f5e0e3348459f2e4dc8fd0d9298
|
||||||
$ cachix use hnix
|
cachix use hnix
|
||||||
```
|
```
|
||||||
|
|
||||||
## How you can help
|
## How you can help
|
||||||
|
@ -121,8 +120,8 @@ same. You can talk with everyone live on
|
||||||
When you're ready to submit a pull request, test it with:
|
When you're ready to submit a pull request, test it with:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
$ nix-shell --run "LANGUAGE_TESTS=yes cabal v2-test"
|
nix-shell --run "LANGUAGE_TESTS=yes cabal v2-test"
|
||||||
```
|
```
|
||||||
|
|
||||||
Make sure that all the tests that were passing prior to your PR are still
|
Make sure that all the tests that were passing prior to your PR are still
|
||||||
|
@ -135,5 +134,5 @@ run this yourself, first build hnix with `nix-build`, then run the following
|
||||||
command:
|
command:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ ./result/bin/hnix --eval -E "import <nixpkgs> {}" --find
|
./result/bin/hnix --eval -E "import <nixpkgs> {}" --find
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue