From 78030615fbf231089215bac4adfa453451d903db Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sun, 11 Apr 2021 20:37:11 +0200 Subject: [PATCH] Update readme --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2dbfd19..4a004a6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ -To generate the html doc from the .rst files, run `make html`. -You need the Sphinx documentation generator to do that. -A generated doc is available at +To generate the html doc from the .rst files, run these commands: -* https://limnoria-doc.readthedocs.org/ +``` +pip3 install limnoria +git clone https://github.com/Limnoria/Limnoria-doc.git +cd Limnoria-doc +./generate_plugin_doc.py +make html +``` + +You need the Sphinx documentation generator to do that. +A generated doc is available at https://docs.limnoria.net/