Update README.md

ESCOMP · Aug 12, 2024 · 8801d73 · 8801d73
1 parent 412ab5d
commit 8801d73
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,17 @@
 # CAM-SIMA-docs
 CAM-SIMA developer documentation
+
+# Local usage
+## Python environment
+
+Required python libraries (pip install):
+
+- mkdocs
+- mkdocs-material
+
+# Pushing updates
+1. Clone the repository and checkout `main`
+2. Run the server (from top of the repository directory): `mkdocs serve` (or `python -m mkdocs serve`
+3. Open the documentation on your local server: `http://127.0.0.1:8000/`
+4. Make edits
+5. Push directly back to `main`