summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 31 insertions, 0 deletions
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