doc: update the README (since the directory is empty by default)

[nit.git] / doc / README.md

diff --git a/doc/README.md b/doc/README.md
new file mode 100644 (file)
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 <http://nitlanguage.org/doc/>