make the development instructions more consistent

Our setup is already more complex than installing the python
package. To run the functional tests we need a devstack setup
so try direct people to install via devstack rather than
the trivial "pip install".

Also installation.rst was not included in the docs as it was not
referenced. This should be under the new section "getting_started".

Change-Id: Ia234506e783db2c40428c226a4d26000ded8a9b1
This commit is contained in:
Angus Salkeld
2014-01-22 16:08:42 +10:00
parent 16a5af14f5
commit 63cd38b3d7
5 changed files with 26 additions and 28 deletions

View File

@@ -19,20 +19,12 @@ in any language of your choice.
* Free software: Apache 2.0 License. See LICENSE file.
* Documentation: http://wiki.openstack.org/wiki/Solum
Getting started with Solum
--------------------------
=======================
Local development setup
=======================
Install Solum::
$ pip install -e .
Run Solum API server::
$ solum-api
Hit the API server::
$ curl localhost:9777
See the getting_started_ guide.
.. _getting_started: https://solum.readthedocs.org/en/latest/getting_started/index.html
Project Info
-------------

View File

@@ -1,7 +1,3 @@
===============================
Installing Solum using devstack
===============================
The contrib/devstack/ directory contains the files necessary to integrate Solum with devstack.
To install:

View File

@@ -1,4 +1,19 @@
How to Get Started with Solum
=============================
Installing Solum using devstack
-------------------------------
.. include:: ../../../contrib/devstack/README.rst
Local package installation
--------------------------
Install Solum::
$ pip install -e .
Run Solum API server::
$ solum-api
Hit the API server::
$ curl localhost:9777

View File

@@ -2,9 +2,16 @@
Install Solum
=============
Distro specific installation
----------------------------
TODO add docs here on how to install on different distros like:
- debian
- redhat
- suse
- ubuntu
For a development installation use devstack
-------------------------------------------
.. include:: ../../../contrib/devstack/README.rst

View File

@@ -1,12 +0,0 @@
============
Installation
============
At the command line::
$ pip install solum
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv solum
$ pip install solum