openstack/specs-cookiecutter
Code Issues Proposed changes
7ec7def233
specs-cookiecutter/README.rst
Matthew Treinish 59ef111172 Update readme to refer to specs-cookiecutter 
This commit updates the readme to actually refer to itself instead of the
openstack cookiecutter that it was copied from.

Change-Id: Ia33311bc8b0c88177c6661fad98fa62182738fbd
2014-04-25 15:19:48 -04:00

991 B
Raw Blame History

specs-cookiecutter

Cookiecutter template for an OpenStack specs repo projects. 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/specs-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