generic-library/rapidjson
1
0
Fork 0
mirror of https://github.com/Tencent/rapidjson.git synced 2025-03-06 13:41:35 +01:00
Code Issues Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Milo Yip 2014-06-26 11:46:16 +08:00
parent e563b1fb96
commit 2d0bc28be1
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
readme.md
View File

@ -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 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.
JSON(JavaScript Object Notation) is a light-weight data exchange format.
More information about JSON can be obtained at
* http://json.org/
* http://www.ietf.org/rfc/rfc4627.txt
## 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,
1. obtain premake4 http://industriousone.com/premake/download
2. Copy premake4 executable to rapidjson/build
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/
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
To build the tests and examples:
1. Obtain [premake4] (http://industriousone.com/premake/download).
2. Copy premake4 executable to rapidjson/build (or system path)
3. Run `rapidjson/build/premake.bat` on Windows, `rapidjson/build/premake.sh` on Linux or other platforms
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`)
6. On success, the executable are generated at `rapidjson/bin`