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

Update docs for v0.3.0 release of C++ api

Browse Source
This commit is contained in:
Jason Paryani
2013-09-04 10:38:00 -07:00
parent e7da4859de
commit f51c34361d
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -7,11 +7,11 @@ More thorough docs are available at [http://jparyani.github.io/pycapnp/](http://
First you need a system-wide installation of the Cap'n Proto C++ library >= 0.3. Follow the [official installation docs](http://kentonv.github.io/capnproto/install.html) or for the lazy: First you need a system-wide installation of the Cap'n Proto C++ library >= 0.3. Follow the [official installation docs](http://kentonv.github.io/capnproto/install.html) or for the lazy:
```bash ```bash
wget http://capnproto.org/capnproto-c++-0.3.0-rc5.tar.gz curl -O http://capnproto.org/capnproto-c++-0.3.0.tar.gz
tar xzf capnproto-c++-0.3.0-rc5.tar.gz tar zxf capnproto-c++-0.3.0.tar.gz
cd capnproto-c++-0.3.0-rc5 cd capnproto-c++-0.3.0
./configure ./configure
make -j8 check make -j6 check
sudo make install sudo make install
``` ```

8
docs/install.rst
View File

@@ -8,11 +8,11 @@ C++ Cap'n Proto Library
You need to install the C++ Cap'n Proto library first. It requires a C++ compiler with C++11 support, such as GCC 4.7+ or Clang 3.2+. Follow installation docs at `http://kentonv.github.io/capnproto/install.html <http://kentonv.github.io/capnproto/install.html>`_, or if you're feeling lazy, you can run the commands below:: You need to install the C++ Cap'n Proto library first. It requires a C++ compiler with C++11 support, such as GCC 4.7+ or Clang 3.2+. Follow installation docs at `http://kentonv.github.io/capnproto/install.html <http://kentonv.github.io/capnproto/install.html>`_, or if you're feeling lazy, you can run the commands below::
wget http://capnproto.org/capnproto-c++-0.3.0-rc5.tar.gz curl -O http://capnproto.org/capnproto-c++-0.3.0.tar.gz
tar xzf capnproto-c++-0.3.0-rc5.tar.gz tar zxf capnproto-c++-0.3.0.tar.gz
cd capnproto-c++-0.3.0-rc5 cd capnproto-c++-0.3.0
./configure ./configure
make -j8 check make -j6 check
sudo make install sudo make install
Pip Pip

4
docs/quickstart.rst
View File

@@ -217,8 +217,8 @@ And similarly for reading::
f = open('example.bin') f = open('example.bin')
addresses = addressbook.AddressBook.read(f) addresses = addressbook.AddressBook.read(f)
Dictionaries Dictionaries (Experimental)
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is a convenience method for converting Cap'n Proto messages to a dictionary. This works for both Builder and Reader type messages:: There is a convenience method for converting Cap'n Proto messages to a dictionary. This works for both Builder and Reader type messages::