diff options
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 |