Change readme format from rst to markdown.

Conflicts:
	README.rst
remotes/origin/enhancement/email-actions
Andrey Antukh 2014-10-03 15:16:44 +02:00
parent 1992c55aca
commit 3cb223d002
2 changed files with 33 additions and 42 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# Taiga Backend #
![Kaleidos Project](http://kaleidos.net/static/img/badge.png "Kaleidos Project")
[![Travis Badge](https://img.shields.io/travis/taigaio/taiga-back.svg?style=flat)](https://travis-ci.org/taigaio/taiga-back "Travis Badge")
[![Coveralls](http://img.shields.io/coveralls/taigaio/taiga-back.svg?style=flat)](https://travis-ci.org/taigaio/taiga-back "Coveralls")
## Setup development environment ##
Just execute these commands in your virtualenv(wrapper):
```
pip install -r requirements.txt
python manage.py migrate --noinput
python manage.py loaddata initial_user
python manage.py loaddata initial_project_templates
python manage.py loaddata initial_role
python manage.py sample_data
```
Taiga only runs with python 3.3+.
Initial auth data: admin/123123
If you want a complete environment for production usage, you can try the taiga bootstrapping
scripts https://github.com/taigaio/taiga-script (warning: alpha state)
## Community ##
[Taiga has a mailing list](http://groups.google.com/d/forum/taigaio). Feel free to join it and ask any questions you may have.
To subscribe for announcements of releases, important changes and so on, please follow [@taigaio](https://twitter.com/taigaio) on Twitter.

View File

@ -1,42 +0,0 @@
Taiga Backend
=================
.. image:: http://kaleidos.net/static/img/badge.png
:target: http://kaleidos.net/community/taiga/
.. image:: https://travis-ci.org/taigaio/taiga-back.png?branch=master
:target: https://travis-ci.org/taigaio/taiga-back
.. image:: https://coveralls.io/repos/taigaio/taiga-back/badge.png?branch=master
:target: https://coveralls.io/r/taigaio/taiga-back?branch=master
Setup development environment
-----------------------------
*Taiga only runs with Python 3.3+.*
Just execute these commands in your virtualenv(wrapper):
.. code-block:: console
pip install -r requirements.txt
python manage.py migrate --noinput
python manage.py loaddata initial_user
python manage.py loaddata initial_project_templates
python manage.py loaddata initial_role
python manage.py sample_data
Initial auth data: admin/123123
If you want a complete environment for production usage, you can try the taiga bootstrapping
scripts https://github.com/taigaio/taiga-scripts (warning: alpha state)
Configuration
-------------
Configuration is on the `taiga-back/settings/local.py` file.
After modifing the configuration, you have to restart taiga-back.