feat: add readme

rokubun · May 22, 2024 · 2382912 · 2382912
1 parent 76fe02a
commit 2382912
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# MEDEA Documentation
+
+## Local build
+
+### Installing required tools
+```console
+rokubuner@linux:~$ sudo apt-get install  mkdocs
+rokubuner@linux:~$ sudo mv /usr/lib/python3.12/EXTERNALLY-MANAGED /usr/lib/python3.12/EXTERNALLY-MANAGED_old
+rokubuner@linux:~$ pip install mkdocs-material 
+```
+
+### Running in local
+```console
+rokubuner@linux:~$ mkdocs serve
+```
+
+## CI
+
+New commits on this repository will automatically trigger a deploy at https://medea.docs.rokubun.cat/