Skip to content

Commit 2717bbf

Browse files
committed
Update development guide
Signed-off-by: Robert Young <[email protected]>
1 parent 707f4fa commit 2717bbf

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,22 @@ You'll also need to ensure you have Ruby 3.2+ installed, along with the latest v
1414

1515
## Development
1616

17-
Built with Jekyll, Bootstrap 5, and Ruby 3.2
17+
Built with Jekyll, Bootstrap 5, and Ruby 3.4
1818

19-
There is a GitHub action that builds and deploys the HTML/CSS
20-
to the `gh-pages` branch on push to `main`.
19+
There is a GitHub action that builds and deploys the HTML/CSS on push to `main`.
2120

2221
We don't use the Bootstrap 5 ruby gem here, as it runs on a
2322
`dart-sass` implementation that's incompatible with the one Jekyll uses.
2423

25-
### Running Locally
24+
### Running in a Container
2625

27-
To run the site locally, you'll first need to download the Bootstrap 5 Sass sources by running [bootstrap_setup.sh](bootstrap_setup.sh).
26+
To build and serve the website from a container you can run `./run.sh`. It will be deployed on http://localhost:4000
27+
28+
This assumes the use of `podman`, if you are a `docker` user you can run `CONTAINER_ENGINE=docker ./run.sh`.
29+
30+
### Running Natively
31+
32+
To run the site natively, you'll first need to download the Bootstrap 5 Sass sources by running [bootstrap_setup.sh](bootstrap_setup.sh).
2833

2934
Then install the site's prerequisites by running this:
3035

0 commit comments

Comments
 (0)