Skip to content

Commit 463d228

Browse files
update readme
1 parent 7c4756f commit 463d228

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ Some of the others are
1111
* www.haskell.org/platform (built from [haskell-platform](https://github.com/haskell/haskell-platform/tree/master/website))
1212
* www.haskell.org/ghcup (build from [ghcup-hs](https://gitlab.haskell.org/haskell/ghcup-hs/-/tree/master/www)
1313

14-
### Nix
15-
16-
The best way to make changes to haskell.org is to use nix. You can install it
17-
by following the directions [on the nix downloads page](https://nixos.org/download.html).
18-
1914
### Contributing Changes
2015

2116
The easiest way to make changes is to use the `buildAndWatch` script and then
@@ -43,38 +38,41 @@ instructions in the _Contributing Changes_ section above.
4338

4439
If you want to make a quick change or two, you can continue to use the
4540
`buildAndWatch` script to rebuild changes, but for more substantial changes this
46-
might increase the build cycle time too much. In that case, you can test your
47-
changes more immediately by building with `cabal`.
48-
49-
If you want to ensure that you are using the correct versions of all of the
50-
libraries, you can develop inside of a nix shell. To do that, simply type:
41+
might increase the build cycle time too much. In this case, you can build the
42+
builder using either nix or cabal. Directions for both are given below:
5143

52-
`nix-shell` from either the project root directory or the `builder` directory.
44+
<a id="buildingWithoutNix"></a>
45+
### Manually Building the Site With Cabal
5346

54-
To build the builder with cabal, go into the `builder` directory and run:
47+
If you don't have nix installed, or if you are inside of the project's nix
48+
shell, you will want to use cabal to compile the builder. To do so, enter the
49+
`builder` directory and compile the program with:
5550

56-
```
51+
```shell
5752
cabal v2-build
5853
```
5954

60-
### Manually Building the Site with the Builder
61-
62-
If you want to manually build the site with the builder, you need to run the
63-
builder from the project root directory. You can do this by building the site
64-
with nix:
55+
Once compiled, the builder must be run from the project root directory so that
56+
it can find all of the content. To run the builder, you need to first find the
57+
name of the executable. From the builder directory, you can find the executable
58+
path by running:
6559

6660
```
67-
nix-build -A builder
61+
find dist-newstyle -name 'haskell-org-site' -type f
6862
```
6963

70-
Then running the builder binary from the `result` directory:
64+
Using that path, you can run the builder from the project root directory.
65+
66+
### Manually Building the Site With Nix
67+
68+
If you have nix installed, you can have nix build the builder by running:
7169

7270
```
73-
./result/bin/haskell-org-site build
71+
nix-build -A builder
7472
```
7573

76-
Alternatively you can build with cabal and run the executable directly:
74+
You may then run the builder binary from the `result` directory:
7775

7876
```
79-
./builder/dist-newstyle/build/x86_64-linux/ghc-8.8.4/haskell-org-0.1.0.0/x/haskell-org-site/build/haskell-org-site/haskell-org-site build
77+
./result/bin/haskell-org-site build
8078
```

0 commit comments

Comments
 (0)