aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Pulford <mark@kyne.com.au>2011-12-15 21:55:14 +1030
committerMark Pulford <mark@kyne.com.au>2011-12-15 21:55:14 +1030
commit9bb1f928e03a022e7382b1d9c7b14384fe348ffb (patch)
tree0665bfe37410a878638f3d2a5dbd99580c3e5a23
parentd9aafecde941ae85334462269e521f5a9e1c9d6c (diff)
downloadlua-cjson-9bb1f928e03a022e7382b1d9c7b14384fe348ffb.tar.gz
lua-cjson-9bb1f928e03a022e7382b1d9c7b14384fe348ffb.tar.bz2
lua-cjson-9bb1f928e03a022e7382b1d9c7b14384fe348ffb.zip
Add CMake build documentation
-rw-r--r--manual.txt33
1 files changed, 26 insertions, 7 deletions
diff --git a/manual.txt b/manual.txt
index dc3c26f..39adef8 100644
--- a/manual.txt
+++ b/manual.txt
@@ -19,7 +19,7 @@ Lua CJSON provides fast JSON parsing and encoding support for Lua.
19- Multi-threading within a single Lua state is not supported. 19- Multi-threading within a single Lua state is not supported.
20 However, this is not a recommended configuration under Lua. 20 However, this is not a recommended configuration under Lua.
21 21
22Lua CJSON is covered by the MIT license. See the file +LICENSE+ for 22Lua CJSON is covered by the MIT license. Review the file +LICENSE+ for
23details. 23details.
24 24
25The latest version of this software is available from the 25The latest version of this software is available from the
@@ -35,14 +35,16 @@ Installation Methods
35Lua CJSON requires either http://www.lua.org[Lua] or 35Lua CJSON requires either http://www.lua.org[Lua] or
36http://www.luajit.org[LuaJIT] to build. 36http://www.luajit.org[LuaJIT] to build.
37 37
38There are 3 build methods available: 38There are 4 build methods available:
39 39
40Make:: 40Make::
41 POSIX (including Linux, BSD, Mac OSX & Solaris) 41 Unix (including Linux, BSD, Mac OSX & Solaris)
42CMake::
43 Unix, Windows
42RPM:: 44RPM::
43 Linux 45 Linux
44LuaRocks:: 46LuaRocks::
45 POSIX (including Linux, BSD, Mac OSX & Solaris), Windows 47 Unix, Windows
46 48
47 49
48Build options (#define) 50Build options (#define)
@@ -52,7 +54,7 @@ Lua CJSON uses +strtod+(3) and +snprintf+(3) to perform numeric
52conversion as they are usually well supported, fast and bug free. To 54conversion as they are usually well supported, fast and bug free. To
53ensure JSON encoding/decoding works correctly for locales using comma 55ensure JSON encoding/decoding works correctly for locales using comma
54decimal separators, Lua CJSON may optionally be compiled with one of 56decimal separators, Lua CJSON may optionally be compiled with one of
55the following (+#define+): 57the following preprocessor macros:
56 58
57USE_POSIX_USELOCALE:: 59USE_POSIX_USELOCALE::
58 Thread safe. Supported by Linux and Mac OSX. Recommended where available. 60 Thread safe. Supported by Linux and Mac OSX. Recommended where available.
@@ -81,6 +83,23 @@ make
81cp cjson.so $your_lua_module_directory 83cp cjson.so $your_lua_module_directory
82 84
83 85
86CMake
87~~~~~
88
89http://www.cmake.org[CMake] can generate build configuration for many different
90platforms (including Unix and Windows).
91
92[source,sh]
93mkdir build
94cd build
95cmake ..
96make
97cp cjson.so $your_lua_module_directory
98
99Review the http://www.cmake.org/cmake/help/documentation.html[CMake documentation]
100for further details.
101
102
84RPM 103RPM
85~~~ 104~~~
86 105
@@ -110,8 +129,8 @@ LuaRocks does not support platform specific configuration for Solaris.
110On Solaris, you may need to manually uncomment +USE_INTERNAL_ISINF+ in 129On Solaris, you may need to manually uncomment +USE_INTERNAL_ISINF+ in
111the rockspec before building this module. 130the rockspec before building this module.
112 131
113See the http://luarocks.org/en/Documentation[LuaRocks documentation] for 132Review the http://luarocks.org/en/Documentation[LuaRocks documentation]
114further details. 133for further details.
115 134
116 135
117API (Functions) 136API (Functions)