From 8801d732258a1f99c3a8841f4b47d574361d5935 Mon Sep 17 00:00:00 2001 From: Courtney Peverley Date: Mon, 12 Aug 2024 09:40:11 -0600 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 0e029ca..c85b408 100644 --- 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`