deb-sahara/README.rst
Sergey Lukjanov d52b634462 Pre-release 0.1.1 docs fixes
* Update links to the project site:
  http://savanna.mirantis.com -> https://savanna.readthedocs.org/en/latest/
* fix quickstart

Change-Id: I00af8d282c97d5a7e131a9fae83edb85261852d8
2013-05-08 15:23:25 +04:00

54 lines
1.3 KiB
ReStructuredText

Savanna project
===============
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
Architecture draft: https://savanna.readthedocs.org/en/latest/architecture.html
Roadmap: https://savanna.readthedocs.org/en/latest/roadmap.html
API draft: https://savanna.readthedocs.org/en/latest/restapi/v02.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
-------
Copyright (c) 2013 Mirantis Inc.
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0