Skip to content

Commit 3618d26

Browse files
committed
Updated README with installation and build instructions
1 parent 79c7261 commit 3618d26

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,25 @@ This `cabal.nix` will be imported by the `default.nix` to be used as the core de
1818

1919
If this is the first time you've ran `cabal`, then run `cabal update` to get the latest package list in `~/.cabal`.
2020

21-
## Developing inside `nix-shell`
21+
## Installation
22+
23+
If on Nix, you can install just by using:
24+
25+
```sh
26+
nix-env -f ./default.nix -i
27+
```
28+
29+
If you are not, then use `cabal`:
30+
31+
```sh
32+
# you need to first generate the cabal file
33+
hpack
34+
cabal install
35+
```
36+
37+
It installs the executable into `~/.cabal/bin`.
38+
39+
## Developing
2240

2341
Run `nix-shell`, and once you're inside, you can use:
2442

@@ -56,6 +74,12 @@ cabal clean
5674
cabal install
5775
```
5876

77+
Once you have finished developing, you can build the package using:
78+
79+
```sh
80+
nix-build
81+
```
82+
5983
## Using the `package.yaml`
6084

6185
Any module that is meant to be consumed as a library needs to be listed in the `exposed-modules`. Any module that is not listed there are considered to be private modules.

0 commit comments

Comments
 (0)