diff --git a/README.md b/README.md index 5008383..862d23c 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,26 @@ Guides and configuration files of my desktop Void install. To begin go to the [wiki](https://git.bijl.us/lnco/void-desktop-guide/wiki)! + + + +## Prerequisites + +Install `mkdocs` through pip: + +``` +# xbps-install -Sy python3-devel python3-pip +$ pip install mkdocs +``` + +This will put a binary in `~/.local/lib/python3.11/site-packages/mkdocs/__main__.py` + +I would recommended creating an alias for using it. For example: + +``` +alias mkdocs="python ~/.local/lib/python3.11/site-packages/mkdocs/__main__.py" +``` + +## "Compiling" + +(unfinished) \ No newline at end of file