diff options
| author | INADA Naoki <songofacandy@gmail.com> | 2011-08-21 19:09:36 +0900 |
|---|---|---|
| committer | INADA Naoki <songofacandy@gmail.com> | 2011-08-21 19:09:36 +0900 |
| commit | 6bc62bd1424b6419e75b99f38199fdfc66d4ec87 (patch) | |
| tree | f212963e9179d4a5bb19e4d8d1e2a85ba0ae8292 /README.rst | |
| parent | cd75ba495af3c153f707c127b0ce6484df6fb1a0 (diff) | |
| download | msgpack-python-6bc62bd1424b6419e75b99f38199fdfc66d4ec87.tar.gz | |
rename README to README.rst
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a7e8c53 --- /dev/null +++ b/README.rst @@ -0,0 +1,42 @@ +=========================== +MessagePack Python Binding +=========================== + +:author: INADA Naoki +:version: 0.1.0 +:date: 2009-07-12 + +HOW TO USE +----------- +You can read document in docstring after `import msgpack` + + +INSTALL +--------- +Cython_ is required to build msgpack. + +.. _Cython: http://www.cython.org/ + +posix +'''''' +You can install msgpack in common way. + + $ python setup.py install + +Windows +'''''''' +MessagePack requires gcc currently. So you need to prepare +MinGW GCC. + + $ python setup.py install -c mingw32 + +TEST +---- +MessagePack uses `nosetest` for testing. +Run test with following command: + + $ nosetests test + + +.. + vim: filetype=rst |