From 4f327d9a31b76a3a23c04708e7b1974371188953 Mon Sep 17 00:00:00 2001 From: Jason Paryani Date: Wed, 28 Aug 2013 22:55:10 -0700 Subject: [PATCH] Update docs for developers --- README.md | 4 ++++ docs/install.rst | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index d6efdb1..5ed3f98 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,10 @@ Or you can clone the repo like so: `cd` into the repo directory and run `pip install .` +## Development + +This project uses [git-flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/). Essentially, just make sure you do your changes in the `develop` branch. + ## Documentation/Example There is some basic documentation [here](http://jparyani.github.io/capnpc-python-cpp/). diff --git a/docs/install.rst b/docs/install.rst index 2eb0275..c6b79ff 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -44,4 +44,13 @@ or:: If you don't use pip, you will need to manually install Cython, and a setuptools with a version >= .8. +Development +------------------- + +Clone the repo from https://github.com/jparyani/capnpc-python-cpp.git and use the `develop` branch. I'll probably ask you to redo pull requests that target `master` and aren't easily mergable to `develop`.:: + + git clone https://github.com/jparyani/capnpc-python-cpp.git + git checkout develop + + Once you're done installing, take a look at the :ref:`quickstart`