marcosh/crem
1
1
Fork 0
mirror of https://github.com/marcosh/crem.git synced 2024-08-16 16:00:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

document how to open haddock docs

Browse Source
This commit is contained in:
Marco Perone 2023-03-07 17:48:55 +01:00 committed by Marco Perone
parent 7cff7bdb24
commit 2b01fd6cbb
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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).