How to build and serve locally

eidorb · Nov 25, 2024 · 3a1e020 · 3a1e020
1 parent 11f26bb
commit 3a1e020
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,3 +11,15 @@ files from this content.
 
 A GitHub workflow (`.github/workflows/deploy.yml`) automatically builds and deploys
 the website when changed.
+
+
+## How to build and serve locally
+
+This installs dependencies, builds the website and opens index.html in a browser:
+
+```bash
+micromamba create --file environment.yml --yes
+micromamba activate "${PWD##*/}" # If dir name == environment name...
+poetry install
+sphinx-build -b html brodie.id.au _build && open _build/index.html
+```