Add a README

This commit is contained in:
Sharoon Thomas 2013-05-21 20:48:22 +05:30
parent 72b179fc8f
commit 66e8a51bed
1 changed files with 54 additions and 0 deletions

54
README.rst Normal file
View File

@ -0,0 +1,54 @@
Nereid Project
===============
A web based project management system built on the Tryton framework and
nereid.
**Nereid Project** is an open-source collaborative development platform offered
by Team Openlabs. It is mainly used for managing project processes. While it
could be used for managing any kind of projects, it is primarily used at
Openlabs to manage software projects. It is designed to help organise projects
& tasks. The aim is to connect everything together on a single interface,
avoiding unecessary time consumption, and track project's progress, task's
status, shared files, time spent on individual tasks.
The goal of nereid project is to provide a friendly web based user interface to
stakeholders outside the company to the powerful project management module of
Tryton.
* Separate user accounts for users outside the company (like customers &
freelancers) without giving access to Tryton.
* Simplify the project management tasks to encourage participation from users
who may not be tech savvy.
Installation
------------
.. code:: sh
$ pip install trytond_nereid_project
To install from source
``````````````````````
.. code:: sh
$ git clone git://github.com/openlabs/nereid-project.git
$ cd nereid-project
$ python setup.py install
Build Status (Master)
---------------------
.. image:: https://travis-ci.org/openlabs/nereid-project.png?branch=master
.. _Master: https://travis-ci.org/openlabs/nereid-project
Build Status (Develop)
---------------------
.. image:: https://travis-ci.org/openlabs/nereid-project.png?branch=develop
.. _Develop: https://travis-ci.org/openlabs/nereid-project