diff --git a/README.md b/README.md new file mode 100644 index 0000000..e626eca --- /dev/null +++ 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/ \ No newline at end of file