From 543b9780f4b1afadc51da78640f96fbcfe8c0405 Mon Sep 17 00:00:00 2001 From: Jean Privat Date: Thu, 27 Nov 2014 12:56:48 -0500 Subject: [PATCH] doc: update the README (since the directory is empty by default) Signed-off-by: Jean Privat --- doc/README | 6 ------ doc/README.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 6 deletions(-) delete mode 100644 doc/README create mode 100644 doc/README.md diff --git a/doc/README b/doc/README deleted file mode 100644 index 0e23e6a..0000000 --- a/doc/README +++ /dev/null @@ -1,6 +0,0 @@ -This directory contains various documentation for Nit - -* advanced_options [TXT]: documentation for advanced options of the compiler and run-time execution. -* stdlib [HTML]: Autodocumentation for the Nit standard library. - -For more documentation, visit http://nitlanguage.org/doc/ diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..406cb02 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,12 @@ +This directory contains auto-documentation generated by nitdoc. + + * [stdlib](http://nitlanguage.org/doc/stdlib/): the Nit libraries (from `../lib/`). + * [nitc](http://nitlanguage.org/doc/nitc/): the Nit tools (from `../src/`). + +Run `make` to produce them. + +Specific documentation can be found elsewhere: + + * The manpages of the Nit tools are in the directory `../share/man` + * The documentation of the other tools and programs are in their subdirectories in `../examples` and `../contrib` + * For more documentation, visit -- 1.7.9.5