summaryrefslogtreecommitdiff
path: root/python/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/README')
-rw-r--r--python/README38
1 files changed, 38 insertions, 0 deletions
diff --git a/python/README b/python/README
new file mode 100644
index 0000000..2b2ebe9
--- /dev/null
+++ b/python/README
@@ -0,0 +1,38 @@
+===========================
+MessagePack Python Binding
+===========================
+
+:author: Naoki INADA
+: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