From 62e7468a6e7f81ce9b1885ec4ca412d6313c7966 Mon Sep 17 00:00:00 2001
From: Phil de Joux <philderbeast@gmail.com>
Date: Mon, 17 Jun 2024 14:02:32 -0400
Subject: [PATCH] Add a note on builder package

- Also mention cabal run as an option
---
 README.md | 27 +++++++++++++++++++--------
 1 file changed, 19 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index f3ffd0f..4ccfa94 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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