TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve readme

Browse Source
pull/992/head
Michael Frister 11 years ago
parent 55a499383c
commit 9b90bde844
2 changed files with 80 additions and 57 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 80
      README.md
  2. 57
      README.rdoc

80
README.md
Unescape View File

@ -0,0 +1,80 @@
# OpenProject
[<img src="https://travis-ci.org/opf/openproject.png?branch=feature/rails3" alt="Build Status" />](https://travis-ci.org/opf/openproject)
[<img src="https://gemnasium.com/opf/openproject.png" alt="Dependency Status" />](https://gemnasium.com/opf/openproject)
OpenProject is a web-based project management software. Its key features are:
* [Work Package Tracking](https://www.openproject.org/projects/openproject/wiki/Work_packages)
* [Project Timelines](https://www.openproject.org/projects/openproject/wiki/Timelines)
* [Wikis](https://www.openproject.org/projects/openproject/wiki/Wiki)
* [Forums](https://www.openproject.org/projects/openproject/wiki/Forums)
Via plugins, it also supports:
* [Meeting Management](https://www.openproject.org/projects/openproject/wiki/Meetings)
* [Scrum Process Support](https://www.openproject.org/projects/openproject/wiki/Agile_teams)
* [Time and Cost Reporting](https://www.openproject.org/projects/openproject/wiki/Time_and_Cost)
* and [others](https://www.openproject.org/projects/plugins).
More information and screenshots can be found on [openproject.org](https://www.openproject.org).
## Installation
There is an [installation guide](https://www.openproject.org/projects/openproject/wiki/Installation) and a [reference of configuration options](doc/CONFIGURATION.md).
## Repository
This repository contains two main branches:
* `dev`: The main development branch. We try to keep it stable in the sense of all tests are passing, but we don't recommend it for production systems.
* `stable`: Contains the latest stable release that we recommend for production use. Use this if you always want the latest version of OpenProject.
## Contact
OpenProject is supported by its community members, both companies and individuals. There are different possibilities of getting help:
* OpenProject [support page](https://www.openproject.org/support)
* E-Mail Support - info@openproject.org
## Contributing
In case you find a bug or need a feature, please create a [new work package on openproject.org](https://www.openproject.org/projects/openproject/work_packages).
If you want to contribute code, feel free to create a pull request on GitHub. Unfortunately we'll have to ask you to sign a [Contributor License Agreement](https://www.openproject.org/projects/openproject/wiki/Contributor_License_Agreement), but you can do that electronically so this shouldn't be too much pain.
You can find more details on the OpenProject Community [contribution page](https://www.openproject.org/projects/openproject/wiki/Contribution).
## Community
OpenProject is driven by an active group of open source enthusiasts: software engineers, project managers, creatives, and consultants. OpenProject is supported by companies as well as individuals. We share the vision to build great open source project collaboration software.
The [OpenProject Foundation (OPF)](https://www.openproject.org/projects/openproject/wiki/OpenProject_Foundation) will give official guidance to the project and the community and oversees contributions and decisions.
## License
OpenProject is licensed under the terms of the GNU General Public License version 3.
See [doc/COPYRIGHT.rdoc](doc/COPYRIGHT.rdoc) for details.
## Credits
### Icons
Thanks to Le Moign Vincent and his fabulous Minicons icons on [webalys.com](http://www.webalys.com/minicons/icons-free-pack.php).
### Lato Font
Thanks to tyPoland Lukasz Dziedzic for his 'Lato' font.
### OpenProject Icon Font
Published and created by the OpenProject Foundation (OPF) under [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/)
with icons from the following sources
[Minicons Free Vector Icons Pack](http://www.webalys.com/minicons) and
[User Interface Design framework](http://www.webalys.com/design-interface-application-framework.php) both by webalys
**Creative Commons License**
OpenProject Icon Font by OpenProject Team is licensed under Creative Commons Attribution 3.0 Unported License
and Free for both personal and commercial use. You can copy, adapt, remix, distribute or transmit it.
Under this condition: provide a mention of the "OpenProject Foundation" and a link back to OpenProject www.openproject.org.

57
README.rdoc
Unescape View File

@ -1,57 +0,0 @@
= OpenProject
{<img src="https://travis-ci.org/opf/openproject.png?branch=feature/rails3" alt="Build Status" />}[https://travis-ci.org/opf/openproject]
{<img src="https://gemnasium.com/opf/openproject.png" alt="Dependency Status" />}[https://gemnasium.com/opf/openproject]
== This is a beta-Release Branch
You are currently on the beta-release branch. We prepare the OpenProject migration from rails version 2.3 to 3.2.
Although this is the main development branch, it is *not* a stable code base. For production usage, we recommend to use the master-branch.
== What we do?
OpenProject is a web-based project management software, driven by an active group of open source enthusiasts: software engineers, project managers, creatives, and consultants. OpenProject is supported by companies as well as individuals. What we share? It is the vision to build great project collaboration software based on open source.
The OpenProject Foundation (OPF) will give official guidance to the project and the community and oversees contributions and decisions.
More information can be found on our website[https://www.openproject.org] and soon in the doc directory.
== Installation
You will find an {installation guide}[https://www.openproject.org/projects/openproject/wiki/Installation] online.
== Get in Contact
OpenProject is supported by its community members, both companies as well as individuals. There are different possibilities of getting help:
* OpenProject {support page}[https://www.openproject.org/support]
* E-Mail Support - info@openproject.org
== Start Collaborating
Join the OpenProject community and start collaborating. We envision building a platform to share ideas, contributions, and discussions around OpenProject and project collaboration. Each commitment is noteworthy as it helps to improve the software and the project.
More details will be added on the OpenProject Community {contribution page}[https://www.openproject.org/projects/openproject/wiki/Contribution].
In case you find a bug or need a feature, please report at https://www.openproject.org/projects/openproject/
== License
OpenProject is licensed under the terms of the GNU General Public License version 3.
See doc/COPYRIGHT.rdoc for details.
== Icons credits:
Thanks to Le Moign Vincent and his fabulous Minicons icons on webalys.com[http://www.webalys.com/minicons/icons-free-pack.php].
== Lato font credits:
Thanks to tyPoland Lukasz Dziedzic for his 'Lato' font.
== OpenProject Icon Font credits:
Published and created by the OpenProject Foundation (OPF) under {Creative Commons Attribution 3.0 Unported License}[http://creativecommons.org/licenses/by/3.0/]
with icons from the following sources
{Minicons Free Vector Icons Pack}[http://www.webalys.com/minicons] and
{User Interface Design framework}[http://www.webalys.com/design-interface-application-framework.php] both by webalys
<b>Creative Commons License</b>
OpenProject Icon Font by OpenProject Team is licensed under Creative Commons Attribution 3.0 Unported License
and Free for both personal and commercial use. You can copy, adapt, remix, distribute or transmit it.
Under this condition: provide a mention of the "OpenProject Foundation" and a link back to OpenProject www.openproject.org.
Write Preview
Loading…
Cancel
Save