Commit 2d0bc28b authored by Milo Yip's avatar Milo Yip

Update readme.md

parent e563b1fb
...@@ -8,29 +8,31 @@ https://github.com/miloyip/rapidjson/ ...@@ -8,29 +8,31 @@ https://github.com/miloyip/rapidjson/
Rapidjson is a JSON parser and generator for C++. It was inspired by [rapidxml](http://rapidxml.sourceforge.net/) Rapidjson is a JSON parser and generator for C++. It was inspired by [rapidxml](http://rapidxml.sourceforge.net/)
Rapidjson is small but complete. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code. * Rapidjson is small but complete. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code.
Rapidjson is fast. Its performance can be comparable to `strlen()`. It also optionally supports SSE2/SSE4.1 for acceleration. * Rapidjson is fast. Its performance can be comparable to `strlen()`. It also optionally supports SSE2/SSE4.1 for acceleration.
Rapidjson is self-contained. It does not depend on external libraries such as BOOST. It even does not depend on STL. * Rapidjson is self-contained. It does not depend on external libraries such as BOOST. It even does not depend on STL.
Rapidjson is memory friendly. Each JSON value occupies exactly 16/20 bytes for most 32/64-bit machines (excluding text string). By default it uses a fast memory allocator, and the parser allocates memory compactly during parsing. * Rapidjson is memory friendly. Each JSON value occupies exactly 16/20 bytes for most 32/64-bit machines (excluding text string). By default it uses a fast memory allocator, and the parser allocates memory compactly during parsing.
For the full features please refer to the user guide. For the full features please refer to the user guide.
JSON(JavaScript Object Notation) is a light-weight data exchange format. JSON(JavaScript Object Notation) is a light-weight data exchange format.
More information about JSON can be obtained at More information about JSON can be obtained at
* http://json.org/ * http://json.org/
* http://www.ietf.org/rfc/rfc4627.txt * http://www.ietf.org/rfc/rfc4627.txt
## Installation ## Installation
Rapidjson is a header-only C++ library. Just copy the rapidjson/include/rapidjson folder to system or project's include path. Rapidjson is a header-only C++ library. Just copy the `rapidjson/include/rapidjson` folder to system or project's include path.
To build the tests and examples:
To build the tests and examples, 1. Obtain [premake4] (http://industriousone.com/premake/download).
1. obtain premake4 http://industriousone.com/premake/download 2. Copy premake4 executable to rapidjson/build (or system path)
2. Copy premake4 executable to rapidjson/build 3. Run `rapidjson/build/premake.bat` on Windows, `rapidjson/build/premake.sh` on Linux or other platforms
3. Run rapidjson/build/premake.bat on Windows, rapidjson/build/premake on Linux or other platforms 4. On Windows, build the solution at `rapidjson/build/vs2008/` or `/vs2010/`
4. On Windows, build the solution at rapidjson/build/vs2008/ or /vs2010/ 5. On other platforms, run GNU make at `rapidjson/build/gmake/` (e.g., `make -f test.make config=release32`, `make -f example.make config=debug32`)
5. On other platforms, run GNU make at rapidjson/build/gmake/ (e.g., make -f test.make config=release32, make -f example.make config=debug32) 6. On success, the executable are generated at `rapidjson/bin`
6. On success, the executable are generated at rapidjson/bin
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment