Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README.

  • Loading branch information...
commit 861cc6e898716d7fca47b77fa676f693e1db1a37 1 parent f89af11
@pgriess authored
Showing with 23 additions and 0 deletions.
  1. +23 −0 README.md
View
23 README.md
@@ -0,0 +1,23 @@
+`node-msgpack` is an addon for [node.js](http://nodejs.org) that provides an
+API for serializing and de-serializing JavaScript objects using the
+[MessagePack](http://msgpack.sourceforge.net) library. The results of this
+serialization are extremely space-efficient compared to JSON.
+
+### Building and installation
+
+Installation is a manual process: use `make` to build the add-on, then manually
+copy it to wherever your node.js installation will look for it (or add the
+build directory to your `$NODE_PATH`).
+
+ % ls
+ LICENSE Makefile README.md deps/ src/ tags test.js
+ % make
+
+The MessagePack library on which this depends is packaged with `node-msgpack`
+and will be built as part of this process.
+
+**Note:** MessagePack may fail to build if you do not have a modern version of
+gcc in your `$PATH`. On Mac OS X Snow Leopard (10.5.x), you may have to use
+`gcc-4.2`, which should come with your box but is not used by default.
+
+ % make CC=gcc-4.2 CXX=gcc-4.2
Please sign in to comment.
Something went wrong with that request. Please try again.