antirez/lua-msgpack — Issue #5: README INSTALLATION section lacks proper installation
Author: agladysh
Created: 2012-02-19 20:54:11+00:00
State: open

This should not be neither a preferred nor the only one documented way to install the module:

> To include this library in your Lua project, just add the lua_msgpack.c file
> and call the following function after creating the Lua interpreter:
>
> luaopen_msgpack(L);

You need to support the other "half" of users, who use the stock interpreter. Even for people, who have built in Lua interpreter to their C program, it is unusual to prefer to directly compile module code into the program —shared libraries are the way to do it unless one has good reasons not to.

You should provide instructions like "build a shared library and put it somewhere in `package.cpath`, then call 'require "msgpack"'". If you do not want to bother, just write a rockspec file (#3) and mention `sudo luarocks install lua-msgpack` (stable release), `sudo luarocks install lua-msgpack --from=rocks-cvs` (for the Git master HEAD on GH) and `sudo luarocks make rockspec/lua-msgpack-scm-1.rockspec` (from local working copy) in the INSTALLATION section.