From e563b1fb960fa136590fff52ccfa9d4993da69e1 Mon Sep 17 00:00:00 2001 From: Milo Yip Date: Thu, 26 Jun 2014 11:38:41 +0800 Subject: [PATCH] Create readme.md --- readme.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6356791 --- /dev/null +++ b/readme.md @@ -0,0 +1,36 @@ +# Rapidjson v0.1 + +Copyright (c) 2011-2014 Milo Yip (miloyip@gmail.com) + +https://github.com/miloyip/rapidjson/ + +## Introduction + +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 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 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. + +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