git » nmdb » commit 0184a5d

Add a reference to the user guide in the README file.

author Alberto Bertogli
2007-01-09 02:54:29 UTC
committer Alberto Bertogli
2007-01-09 02:54:29 UTC
parent fc10f93f096d312ea4638bb36c8f96f0535aac98

Add a reference to the user guide in the README file.

README +8 -0

diff --git a/README b/README
index 7c2fb8d..5b363dd 100644
--- a/README
+++ b/README
@@ -17,6 +17,14 @@ This source distribution is composed of several parts: the server called
 directory, and is licensed individually. See the LICENSE file for more
 information.
 
+
+Documentation
+-------------
+
+Most documentation is in the nmdb and libnmdb manpages, and inside the doc/
+directory. It is recommended that you read the User Guide (doc/guide.rst, or
+the online version) to learn how to setup and use nmdb.
+
 For additional documentation and resources, go to the project's website at
 http://auriga.wearlab.de/~alb/nmdb.