congress/README.rst
Tim Hinrichs 0d63c9e44a Fixing up getting started instructions
When installing on a clean machine, the README
and requirements.txt was inadequate for getting the tests running.

This change fixes up those instructions.

Change-Id: Idba5053e29632bb1295fb6b2148a9f59503435d1
2014-07-24 11:57:46 -07:00

49 lines
725 B
ReStructuredText

===============================
Congress
===============================
Congress: The open policy framework for the cloud.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/congress
0. Install requirements.
- python 2.7 or above
https://www.python.org/download/releases/2.7/
- pip
https://pip.pypa.io/en/latest/installing.html
- java
http://java.com
1. Setup Congress
cd /path/to/congress
sudo python setup.py develop
2. Run the unit tests
cd /path/to/congress
./run_tests.sh -N
OR
tox -epy27
3. Run the API server:
cd /path/to/congress
./bin/congress-server --config-file etc/congress.conf.sample
4. Read docs
Open /path/to/congress/doc/html/index.html in a browser