README and docs has been updated

* links has been updated
* tips moved to the dev guide

Change-Id: I89444a8fa987850ca22b7975707b201f9c76de71
This commit is contained in:
Sergey Lukjanov 2013-07-15 09:45:24 +04:00
parent 992f36936d
commit 64c9cb0249
2 changed files with 34 additions and 36 deletions

View File

@ -5,46 +5,14 @@ Savanna at wiki.openstack.org: https://wiki.openstack.org/wiki/Savanna
Launchpad project: https://launchpad.net/savanna
Project blueprint: https://savanna.readthedocs.org/en/latest/index.html
Savanna docs site: https://savanna.readthedocs.org/en/latest/index.html
Architecture draft: https://savanna.readthedocs.org/en/latest/architecture.html
Roadmap: https://wiki.openstack.org/wiki/Savanna/Roadmap
Roadmap: https://savanna.readthedocs.org/en/latest/roadmap.html
Quickstart guide: https://savanna.readthedocs.org/en/latest/devref/quickstart.html
API draft: https://savanna.readthedocs.org/en/latest/restapi/v02.html
How to participate: https://savanna.readthedocs.org/en/latest/devref/how_to_participate.html
QuickStart (Ubuntu)
----------
Please, take a look at https://savanna.readthedocs.org/en/latest/quickstart.html
Pip speedup
-----------
Add the following lines to ~/.pip/pip.conf
::
[global]
download-cache = /home/<username>/.pip/cache
index-url = <mirror url>
Note! The ~/.pip/cache folder should be created.
Git hook for fast checks
------------------------
Just add the following lines to .git/hooks/pre-commit and do chmod +x for it.
::
#!/bin/sh
# Run fast checks (PEP8 style check and PyFlakes fast static analysis)
tools/run_fast_checks
You can added the same check for pre-push, for example, run_tests and run_pylint.
Running static analysis (PyLint)
--------------------------------
Just run the following command
::
tools/run_pylint
License
-------

View File

@ -83,3 +83,33 @@ Setup local OpenStack dashboard with Savanna plugin
../horizon/dev.environment.guide
Tips and tricks for dev environment
-----------------------------------
1. Pip speedup
Add the following lines to ~/.pip/pip.conf
::
[global]
download-cache = /home/<username>/.pip/cache
index-url = <mirror url>
Note! The ~/.pip/cache folder should be created.
2. Git hook for fast checks
Just add the following lines to .git/hooks/pre-commit and do chmod +x for it.
::
#!/bin/sh
# Run fast checks (PEP8 style check and PyFlakes fast static analysis)
tools/run_fast_checks
You can added the same check for pre-push, for example, run_tests and run_pylint.
3. Running static analysis (PyLint)
Just run the following command
::
tools/run_pylint