From aee806a3f0f5558e10c86bc1f912d124d921552c Mon Sep 17 00:00:00 2001 From: Antonio Terceiro Date: Thu, 19 Sep 2013 09:54:54 -0300 Subject: [PATCH] README: provide a documentation index --- README | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README b/README index 0c7ea16..bc6a77a 100644 --- a/README +++ b/README @@ -1,12 +1,33 @@ -noosfero - a web-based social platform +Noosfero - a web-based social platform ====================================== -:: About the project +http://www.noosfero.org/ -Homepage: http://www.noosfero.org/ +Documentation +------------- -:: Authors and copyright +The following documentation is available: -Authors: see file AUTHORS -Copyright information: see file COPYRIGHT -Full license text; see file COPYING +File Purpose +~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +INSTALL install instructions +INSTALL.awstats install instructions - access statistics service +INSTALL.chat install instructions - chat service +INSTALL.email install instructions - email service +INSTALL.multitenancy install instructions - multiple sites +INSTALL.varnish install instructions - varnish HTTP caching (recommended) +HACKING development instruction +RELEASING instructions for doing releases +doc/noosfero/* user documentation (available through the app itself) + + +Authors and copyright +--------------------- + +Authorship and copyright information is available in the files listed below. + +File Purpose +~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +AUTHORS list of authors (updated at each release) +COPYRIGHT Copyright statement for the project +COPYING Full text of the project license -- libgit2 0.21.2