diff --git a/README b/README deleted file mode 100644 index 1989f25..0000000 --- a/README +++ /dev/null @@ -1,11 +0,0 @@ -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 . - -The .rst files in use/plugins/ has been generate *once* by -`generate_plugin_doc.py` and `append_config_doc.py` (I may have modified them -temporaly to match my file hierarchy). -All of them has been reviewed *and* modified by hand: include unofficial.inc -if needed, and the second-level titles, sort commands by type, ... Don't -even think about running that scripts again on a generated doc, it would -overwrite it. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9bacb34 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +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 .