Skip to content

Commit

Permalink
Add a note on builder package
Browse files Browse the repository at this point in the history
- Also mention cabal run as an option
  • Loading branch information
philderbeast committed Jun 17, 2024
1 parent 5bd0197 commit 62e7468
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,20 @@ to review it as soon as we can.
### Working On The Builder

The `builder` is the static site generator that turns the markdown files, CSS,
images, and scripts into a website. It lives in the `builder`. Most of the time,
you won't need to make changes to the builder and you can follow the
instructions in the _Contributing Changes_ section above.
images, and scripts into a website.

> [!NOTE]
> The package in the builder folder has the `haskell-org-site` executable:
> ```
> $ cat cabal.project
> packages: builder
>
> $ cat builder/haskell-org.cabal | grep executable
> executable haskell-org-site
> ```
Most of the time, you won't need to make changes to the builder and you can
follow the instructions in the _Contributing Changes_ section above.

If you want to make a quick change or two, you can continue to use the
`buildAndWatch` script to rebuild changes, but for more substantial changes this
Expand All @@ -66,18 +77,18 @@ builder using either nix or cabal. Directions for both are given below:
### Manually Building the Site With Cabal

If you don't have nix installed, or if you are inside of the project's nix
shell, you will want to use cabal to compile the builder, the only package in
shell, use cabal to build and execute the builder, the only package in
the project.

```shell
```
$ cabal build all
$ cabal exec haskell-org-site build
```

Once compiled, execute the builder from the project root directory so that it
can find all of the content.
With `cabal run` we can do this in one command.

```
$ cabal exec haskell-org-site build
$ cabal run haskell-org-site -- build
```

### Manually Building the Site With Nix
Expand Down

0 comments on commit 62e7468

Please sign in to comment.