specs-cookiecutter/README.rst

37 lines
985 B
ReStructuredText
Raw Normal View History

2014-03-24 18:41:26 +00:00
======================
cookiecutter-openstack
======================
Cookiecutter template for an OpenStack project. See https://github.com/audreyr/cookiecutter.
* Free software: Apache license
* pbr_: Set up to use Python Build Reasonableness
* OpenStack-Infra_: Ready for OpenStack Continuous Integration testing
* Tox_ testing: Setup to easily building sphunx docs
* Sphinx_ docs: Documentation ready for generation and publication
Usage
-----
Generate a Python package project::
cookiecutter https://git.openstack.org/openstack-dev/cookiecutter.git
OpenStack projects require a working git repo for pbr to work, so you need to
init a repo and commit to it before doing anything else::
cd $repo_name
git init
git add .
git commit -a
Then:
* Add the project to the OpenStack Infrastructure
.. _pbr: http://docs.openstack.org/developer/pbr
.. _OpenStack-Infra: http://ci.openstack.org
.. _Tox: http://testrun.org/tox/
.. _Sphinx: http://sphinx-doc.org/