From 1b6f4f4baf66b2497c2bd3446a15700fed525f05 Mon Sep 17 00:00:00 2001
From: simon <simobilleter@gmail.com>
Date: Mon, 20 Mar 2023 10:35:43 +0700
Subject: [PATCH] add dev environment instructions

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 7392074..cacf260 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 # Tube Archivist Documentation
 
 This is a work in progress, porting the old wiki to a more flexible documentation framework.
+
+
+## Development Environment
+
+To just make simple changes, edit the markdown files within *mkdocs/docs* direclty.
+
+To setup a local development server:
+
+Install mkdocs with pip:
+```
+pip install mkdocs
+```
+
+From the AUR:
+```
+yay -S mkdocs
+```
+
+More details: [User Guide](https://www.mkdocs.org/user-guide/installation/)
+
+Run the server from the *mkdocs* folder with:
+```
+mkdocs serve
+```
+
+And the site - with live reload enabled - should be available on [localhost:8000](http://localhost:8000/).