Updating README

pull/6827/head
Gregor Schmidt 13 years ago
parent abf0be171c
commit 4c8b984ecd
  1. 22
      COPYRIGHT.txt
  2. 8
      CREDITS.txt
  3. 85
      README.rdoc
  4. 10
      README.txt

@ -0,0 +1,22 @@
ChiliProject Backlogs Plugin
This Plugin adds features, that enable agile teams to work efficiently with
ChiliProject in Scrum projects.
Copyright (C) 2010-2011 - Emiliano Heyns, Mark Maglana, friflaj
Copyright (C) 2011 - Jens Ulferts, Gregor Schmidt - Finn GmbH - Berlin, Germany
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.

@ -1,8 +0,0 @@
Thanks to the following people for their help:
* Mark Maglana - Project maintainer
* Emiliano Heyns - Project maintainer
* Guy Naor - Project sponsorship
* G2iX - Project sponsorship
* Eric Davis - For the advice on the model patching pattern magic
* Everyone at Redmine.org - For the pure awesomeness that is Redmine :-)

@ -0,0 +1,85 @@
= ChiliProject Backlogs Plugin
This Plugin adds features, that enable agile teams to work efficiently with
ChiliProject in Scrum projects.
It is largely based on {Redmine Backlogs}[http://www.redminebacklogs.net/].
Development was separated from Redmine Backlogs in March 2011. At this time
Redmine Backlogs v0.3.2 was current. ChiliProject Backlogs is more than just a
port from Redmine to ChiliProject.
== Requirements
This plugin depends on the {ChiliProject NIssue
Plugin}[https://github.com/finnlabs/chiliproject_nissue]. Make sure, to have a
current version of that Plugin installed into your ChiliProject.
This plugin requires some additional RubyGems. After you have extracted the
plugin into `vendor/plugins`, make sure to run `bundle install` to install these
additional dependencies.
This plugin aims to be compatible with
* ChiliProject 1.x
* ChiliProject 2.x
If you are running into compatibility issues, please report a bug in the
project's issue tracker.
== Installation
Please follow the default {plugin installation instructions for
ChiliProject}[https://www.chiliproject.org/projects/chiliproject/wiki/Plugin_Install].
If you did not do it already, run the plugin's migrations.
rake db:migrate:plugin NAME=chiliproject_backlogs RAILS_ENV=production
== Deinstallation
Run the down-migrations to clean up your database.
rake db:migrate:plugin VERSION=0 NAME=chiliproject_backlogs RAILS_ENV=production
Afterwards simply remove the plugin's directory from your vendor/plugins
directory.
== Development
To run the tests, you will need a current version of our {ChiliProject Dev
Tools}[https://github.com/finnlabs/redmine-dev-tools]. After running
bundle install
You should be able to execute the tests with
rake redmine:rspec:backlogs
rake redmine:cucumber:backlogs RAILS_ENV=test
If these instructions are insufficient, please open a ticket in the GitHub issue
tracker with information, where you are stuck.
== Credits
We thank the original maintainers and developers of {Redmine
Backlogs}[http://www.redminebacklogs.net/] for their immense work on this
plugin. ChiliProject Backlogs would not have been possible without their
original contribution.
Additionally, we would like to thank
* Deutsche Telekom AG (opensource@telekom.de) for project sponsorhip
* Birthe Russmeyer and Niels Lindenthal of finnlabs for their consulting and
project management
== Licence
(c) 2010-2011 - Emiliano Heyns, Mark Maglana, friflaj
(c) 2011 - Jens Ulferts, Gregor Schmidt - Finn GmbH
This plugin is licensed under the GNU GPL v2. See COPYRIGHT.txt and GPL.txt for details.

@ -1,10 +0,0 @@
REDMINE BACKLOGS
----------------
A Redmine plugin for agile teams. For more information,
please visit http://www.redminebacklogs.net
LICENSE
-------
This plugin is released under the GPL v2 license. See
LICENSE for more information.
Loading…
Cancel
Save