From 00737ebf49d8b955a336de89b47e227862a785e2 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 20:22:05 +0300 Subject: [PATCH 1/2] README.md: multiple fixes * Convert to markdown. * Fix grammar. * Fix link to generated documentation (supybot.fr.cr --> supybot.aperio.fr). --- README | 11 ----------- README.md | 11 +++++++++++ 2 files changed, 11 insertions(+), 11 deletions(-) delete mode 100644 README create mode 100644 README.md 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..aa08ee6 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +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/ have been generated *once* by +`generate_plugin_doc.py` and `append_config_doc.py` (I may have modified +them temporarily 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 those scripts again on a generated documentation, +it would overwrite it. From c5764728a48a989fc1bb9cbcfbfa6e5a7434cd9a Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 21:12:12 +0300 Subject: [PATCH 2/2] README.md: remove the second paragraph > 2014-06-30 21:11:00+0300 < pinkieval> er > 2014-06-30 21:11:09+0300 < pinkieval> you can remove the second paragraph --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index aa08ee6..9bacb34 100644 --- a/README.md +++ b/README.md @@ -1,11 +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 . - -The .rst files in use/plugins/ have been generated *once* by -`generate_plugin_doc.py` and `append_config_doc.py` (I may have modified -them temporarily 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 those scripts again on a generated documentation, -it would overwrite it.