From d8ca5085666f48cd51ba96ee0a95dcfa4ce2c0e1 Mon Sep 17 00:00:00 2001 From: Eric Davis <edavis@littlestreamsoftware.com> Date: Sat, 26 Feb 2011 13:31:17 -0800 Subject: [PATCH] [#211] Rewrite the Readme with an overview of the project --- README.rdoc | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.rdoc b/README.rdoc index 10c170474..c0d064a20 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,5 +1,30 @@ -= Redmine += ChiliProject -Redmine is a flexible project management web application written using Ruby on Rails framework. +ChiliProject is a web based project management system. It supports your team throughout the complete project life cycle, from setting up and discussing a project plan, over tracking issues and reporting work progress to collaboratively sharing knowledge. -More details can be found at in the doc directory or on the official website http://www.redmine.org +More documentation and user guides can be found on the official website[https://www.chiliproject.org] and in the doc/ directory. + +== Getting Started + +We have a complete {install guide}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation] online. A short version of it is mirrored to doc/INSTALL for offline installations + +== Getting Help + +ChiliProject is an run by a community of volunteers. We have set up different ways to get help depending on your preferences. + +* Self guided help and user documentation - https://www.chiliproject.org/projects/chiliproject/wiki/Help +* Forums for specific questions - https://www.chiliproject.org/projects/chiliproject/boards +* Real time chat using IRC - https://www.chiliproject.org/projects/chiliproject/wiki/IRC +* Commercial support - https://www.chiliproject.org/projects/chiliproject/wiki/Commercial_Offerings + +== Contributing + +We welcome all help for the project, no task is too small. Our documentation is editable by anyone on our wiki[https://www.chiliproject.org/projects/chiliproject/wiki], we accept patches on our {issue tracker}[https://www.chiliproject.org/projects/chiliproject/issues], and everyone is welcome to discuss the project in our forums[https://www.chiliproject.org/projects/chiliproject/boards]. + +More details can be found on our Contribute page[https://www.chiliproject.org/projects/chiliproject/wiki/Contribute]. + +== License + +ChiliProject is licensed under the GNU GPL v2. See the doc directory for more details. + +ChiliProject is a fork based on Redmine. Redmine is Copyright Jean-Philippe Lang and others. -- GitLab