diff options
| author | Mark McLoughlin <markmc@redhat.com> | 2013-05-09 23:09:36 +0100 |
|---|---|---|
| committer | Mark McLoughlin <markmc@redhat.com> | 2013-05-09 23:09:36 +0100 |
| commit | 765fdc858f5008db27c10264a9ba01eddc2adc9d (patch) | |
| tree | 8c988eed1b8aaa178c933870c91331d3cd2b2f83 | |
| parent | e523c8c591806454e0e326bbdac57508787f8d24 (diff) | |
| download | oslo-765fdc858f5008db27c10264a9ba01eddc2adc9d.tar.gz oslo-765fdc858f5008db27c10264a9ba01eddc2adc9d.tar.xz oslo-765fdc858f5008db27c10264a9ba01eddc2adc9d.zip | |
Minor README improvement
Make it a .rst, add a link to the wiki page, mention that this repo is
an incubator.
Change-Id: I47a1b6f5811ce476393ac94c3b11eec61b3984e3
| -rw-r--r-- | README | 11 | ||||
| -rw-r--r-- | README.rst | 31 |
2 files changed, 31 insertions, 11 deletions
@@ -1,11 +0,0 @@ -Common code for Openstack Projects. - -To run tests in virtualenvs (preferred): - - sudo pip install tox - tox - -To run tests in the current environment: - - sudo pip install -r tools/pip-requires - nosetests diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..33b88ab --- /dev/null +++ b/README.rst @@ -0,0 +1,31 @@ +------------------ +The Oslo Incubator +------------------ + +The Oslo program produces a set of python libraries containing +infrastructure code shared by OpenStack projects. The APIs provided by +these libraries should be high quality, stable, consistent and +generally useful. + +The process of developing a new Oslo API usually begins by taking code +which is common to some OpenStack projects and moving it into this +repository. Incubation shouldn't be seen as a long term option for any +API - it is merely a stepping stone to inclusion into a published Oslo +library. + +For more information, see our wiki page: + + https://wiki.openstack.org/wiki/Oslo + +Running Tests +------------- + +To run tests in virtualenvs (preferred): + + sudo pip install tox + tox + +To run tests in the current environment: + + sudo pip install -r tools/pip-requires + nosetests |