Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/miloyip/rapidjson.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilo Yip <miloyip@gmail.com>2014-06-26 07:46:16 +0400
committerMilo Yip <miloyip@gmail.com>2014-06-26 07:46:16 +0400
commit2d0bc28be19312ae39183d53806a29fb9002d2d0 (patch)
tree8b239eb2760787c71bea88c451fa90fd584f945e /readme.md
parente563b1fb960fa136590fff52ccfa9d4993da69e1 (diff)
Update readme.md
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/readme.md b/readme.md
index 63567918..7dea2bfd 100644
--- a/readme.md
+++ b/readme.md
@@ -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:
-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
+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`