IQ.Lvbs/pycapnp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs for developers

Browse Source
This commit is contained in:
Jason Paryani
2013-08-28 22:55:10 -07:00
parent 64b3baa575
commit 4f327d9a31
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -35,6 +35,10 @@ Or you can clone the repo like so:
`cd` into the repo directory and run `pip install .` `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 ## Documentation/Example
There is some basic documentation [here](http://jparyani.github.io/capnpc-python-cpp/). There is some basic documentation [here](http://jparyani.github.io/capnpc-python-cpp/).

9
docs/install.rst
View File

@@ -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. 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` Once you're done installing, take a look at the :ref:`quickstart`