README to facilitate those wanting to work on the project

CleanroomMC · Jan 9, 2024 · 89364e1 · 89364e1
1 parent 2bb2587
commit 89364e1
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Encyclopedia
+
+This is the official repository for [CleanroomMC's Encyclopedia (aka Wikipedia)](https://wiki.cleanroommc.com/)
+
+## Build Locally
+
+- Requires [pip](https://pypi.org/project/pip/)
+
+```cmd
+>pip install -r requirements.txt
+>mkdocs serve
+```
+
+Open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) to see the site. Refresh is triggered whenever a file is manipulated within the local filesystem.