doc/README

   1 == redMine\r
   2 \r
   3 redMine - project management software\r
   4 Copyright (C) 2006-2007  Jean-Philippe Lang\r
   5 http://redmine.rubyforge.org/\r
   6 \r
   7 == License\r
   8 \r
   9 This program is free software; you can redistribute it and/or\r
  10 modify it under the terms of the GNU General Public License\r
  11 as published by the Free Software Foundation; either version 2\r
  12 of the License, or (at your option) any later version.\r
  13 \r
  14 This program is distributed in the hope that it will be useful,\r
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  17 GNU General Public License for more details.\r
  18 \r
  19 You should have received a copy of the GNU General Public License\r
  20 along with this program; if not, write to the Free Software\r
  21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\r
  22 \r
  23 \r
  24 == Main features\r
  25 \r
  26 redMine is a flexible project management web application written using Ruby on Rails.\r
  27 \r
  28 * Multiple users/multiple projects\r
  29 * Fully customizable role based access control\r
  30 * Issue tracking system\r
  31 * Fully customizable workflow\r
  32 * Documents/files repository\r
  33 * Forums\r
  34 * News management\r
  35 * Per project Wiki\r
  36 * Time tracking\r
  37 * Repository browser and diff viewer\r
  38 * Email notifications\r
  39 * Custom fields for projects, users and issues\r
  40 * Multiple LDAP authentication support\r
  41 * User self-registration support\r
  42 * Multilanguage support\r
  43 * Multiple repositories support\r
  44 * Multiple databases support\r
  45 \r
  46 \r
  47 == User documentation\r
  48 \r
  49 User documentation for redMine is written using DocBook XML format.\r
  50 It's also avaible as HTML files in /public/manual (contextual help)\r
  51 \r
  52 \r
  53 == Versioning\r
  54 \r
  55 redMine versioning scheme is major.minor.revision\r
  56 Versions before 1.0.0 must be considered as beta versions and upgrading support\r
  57 may not be provided for these versions.\r
  58 \r
  59 \r
  60 == Credits\r
  61 \r
  62 * Jean-Francois Boutier (spanish translation)\r
  63 * Andreas Viklund (open source XHTML layout, http://andreasviklund.com/)\r
  64 * Karim Trott (german translation)\r
  65 * Todd McGrath (help with english translation)\r
  66 * Satoru Kurashiki (japanese translation)\r
  67 * Alessio Spadaro (italian translation)\r
  68 * Andy Wu (chinese simplified translation)\r
  69 * Thomas Löber (german translation)\r
  70 * Daniel Weinand (german translation)\r
  71 * Joao Carlos Clementoni (portuguese translation)\r
  72 * Cyril Mougel (side by side diff)\r
  73 * Nikolay Solakov (Bulgarian translation)\r
  74 * Linda van den Brink (Dutch translation)\r
  75 * Pavol Murin (Wiki attachments)\r
  76 * Thomas Habets (Swedish translation)\r
  77 * Ralph Vater (CVS adapter)\r