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
This commit is contained in:
Tim Hinrichs 2014-07-23 14:48:10 -07:00
parent 846d082d5d
commit 0d63c9e44a
3 changed files with 38 additions and 10 deletions

View File

@ -7,18 +7,42 @@ Congress: The open policy framework for the cloud.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/congress
1. Compile:
- from the root directory
make
0. Install requirements.
2. Run the API server:
- python 2.7 or above
https://www.python.org/download/releases/2.7/
- from the root directory
./bin/congress-server --config-file congress/etc/congress.sample.conf
- pip
https://pip.pypa.io/en/latest/installing.html
3. Run the unit tests
- java
http://java.com
- from the root directory
tox -epy27 or via ./run_test.sh
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

View File

@ -3,6 +3,7 @@ Babel>=1.3
eventlet>=0.13.0
mox<1.0
pbr>=0.6,!=0.7,<1.0
posix_ipc
python-novaclient>=2.17.0
python-neutronclient>=2.3.5,<3
six>=1.7.0

View File

@ -4,10 +4,13 @@ httpretty>=0.8.0,!=0.8.1,!=0.8.2
coverage>=3.6
discover
fixtures>=0.3.14
mock>=1.0
python-subunit
sphinx>=1.1.2
oslo.sphinx
testrepository>=0.0.17
testscenarios>=0.4,<0.5
testtools>=0.9.32
mock>=1.0
tox<1.7
virtualenv>=1.9.1