mirror of
https://github.com/marcosh/crem.git
synced 2024-09-11 12:36:19 +03:00
document how to open haddock docs
This commit is contained in:
parent
7cff7bdb24
commit
2b01fd6cbb
11
README.md
11
README.md
@ -70,6 +70,7 @@ nix develop .#ghc92
|
||||
```
|
||||
|
||||
Or, without flakes:
|
||||
|
||||
```sh
|
||||
# default GHC
|
||||
nix-shell
|
||||
@ -105,6 +106,7 @@ It is also possible to build the project without entering the development shell.
|
||||
This allows us to build the same way as the CI/CD environment, build with different GHC versions, build container images, etc.
|
||||
|
||||
To do this, run
|
||||
|
||||
```sh
|
||||
# default GHC
|
||||
nix build
|
||||
@ -115,11 +117,20 @@ nix build .#crem.ghc92
|
||||
```
|
||||
|
||||
To view the compilation logs, you can append `-L`:
|
||||
|
||||
```sh
|
||||
nix build -L
|
||||
nix build -L .#crem.ghc92
|
||||
```
|
||||
|
||||
### Haddock documentation
|
||||
|
||||
You can generate and see the [Haddock] documentation by running
|
||||
|
||||
```sh
|
||||
cabal haddock --open
|
||||
```
|
||||
|
||||
## Project setup
|
||||
|
||||
You can find more details on the project setup on [Setup.md](/Setup.md).
|
||||
|
Loading…
Reference in New Issue
Block a user