openproject/doc/README

== redMine

redMine - project management software
Copyright (C) 2006  Jean-Philippe Lang
http://redmine.org/

== License

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.


== Main features

redMine is a project management software written using Ruby on Rails.

* multiple users/projects
* fully customizable role based access control
* issue tracking system
* fully customizable workflow
* documents/files repository
* email notifications
* custom fields for projects, users and issues
* multilanguage support
* multiple LDAP authentication support
* user self-registration support


== User documentation

User documentation for redMine is written using DocBook XML format.
It's also avaible as HTML files in /public/manual (contextual help)


== Versioning

redMine versioning scheme is major.minor.revision
Versions before 1.0.0 must be considered as beta versions and upgrading support
may not be provided for these versions.


== Credits

* Jean-Francois Boutier (spanish translation)
* Andreas Viklund (open source XHTML layout, http://andreasviklund.com/)
* Karim Trott (german translation)