Commit 7f93a89d authored by step21's avatar step21

updated Readme

parent ff86ba3b
......@@ -2,6 +2,20 @@
(Poetic Relief is published under AGPL v3, see LICENSE for details)
Required packages:
* Python 2 (not yet compatible with Python 3)
To Install/Run
* git clone or download the repository
* cd into cloned directory
* virtualenv poe (to create a new evironment)
* source poe/bin/activate to activate the new environment
* pip install -r requirements.txt to install the necessary python packages
* Download the databased (cleaned up) as used in production, and put it into the subdirectory poerelief
* The code is a bit unorganized, but running python run.py in the subdirectory poerelief should start the main app
* Poerelief 0.1.4
- cleaned up database https://mega.co.nz/#!ss1giCDI!obppI2RnUC36lEl2DOuqck8Oig3o6XUWsYyyurXjuMM (to remove square brackets and records that were missing crucial fields)
- better url replacement
......@@ -21,4 +35,4 @@
- proper db access with sqlalchemy orm
* Poerelief 0.1
- initial version/commit
\ No newline at end of file
- initial version/commit
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment