Improve instructions for local builds

pimutils · Oct 10, 2023 · 74ce4e3 · 74ce4e3
1 parent e583167
commit 74ce4e3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .venv
+build
diff --git a/README.md b/README.md
@@ -8,3 +8,22 @@ Issue tracker for organizational matters and website
 The pimutils website is a [Lektor](https://www.getlektor.com/) project. After installing Lektor you should be able to run the admin interface using ``lektor server``. Pushing your changes to master will automatically deploy via Travis to GitHub pages.
 
 The DNS is managed via Markus Unterwaditzer's (@untitaker) private accounts.
+
+## Local usage
+
+Create a virtual environment for lektor:
+
+    mkvirtualenv pimutils-meta
+    pip install -r requirements.txt
+
+Build the project once with:
+
+    lektor build --output-path ./build/
+
+Or watch and rebuild when changes happen:
+
+    fd | entr lektor build --output-path build
+
+The built files can be served locally with just python:
+
+    python -m http.server 6060 -d build