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-30 10:02:30 +0400
committerMilo Yip <miloyip@gmail.com>2014-06-30 10:02:30 +0400
commit8e6da6bdff5676e7ed2ee607927ffcb008c9c484 (patch)
tree798b0b3d6e7840b34c2578a6d8b35ecfe1d175a5 /readme.md
parent9b8424a6b0e667291b0911d3476dd5e0c106402c (diff)
Update readme.md
rapidjson -> RapidJSON
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/readme.md b/readme.md
index 94a92906..29a78196 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,4 @@
-# Rapidjson
+# RapidJSON
Copyright (c) 2011-2014 Milo Yip (miloyip@gmail.com)
@@ -6,28 +6,28 @@ 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 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.
-* Rapidjson is Unicode friendly. It supports UTF-8, UTF-16, UTF-32 (LE & BE), and their detection, validataton and transcoding internally. For example, you can read a UTF-8 file and let rapidjson transcode the JSON strings into UTF-16 in the DOM. It also supports surrogates and "\u0000" (null character).
+* RapidJSON is Unicode friendly. It supports UTF-8, UTF-16, UTF-32 (LE & BE), and their detection, validataton and transcoding internally. For example, you can read a UTF-8 file and let RapidJSON transcode the JSON strings into UTF-16 in the DOM. It also supports surrogates and "\u0000" (null character).
More features can be read [here](doc/features.md).
-JSON(JavaScript Object Notation) is a light-weight data exchange format. Rapidjson should be in fully compliance with RFC4627/ECMA-404. More information about JSON can be obtained at
+JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in fully compliance with RFC4627/ECMA-404. More information about JSON can be obtained at
* [Introducing JSON](http://json.org/)
* [RFC4627: The application/json Media Type for JavaScript Object Notation (JSON)](http://www.ietf.org/rfc/rfc4627.txt)
* [Standard ECMA-404: The JSON Data Interchange Format](http://www.ecma-international.org/publications/standards/Ecma-404.htm)
## Compatibility
-Rapidjson is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.
+RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.
* Visual C++ 2008/2010/2013 on Windows (32/64-bit)
* GNU C++ 3.8.x on Cygwin
* Clang 3.4 on Mac OS X (32/64-bit) and iOS
@@ -37,16 +37,16 @@ Users can build and run the unit tests on their platform/compiler.
## 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 (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`
+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`
## Usage at a glance