• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# JsonCpp
2
3[JSON][json-org] is a lightweight data-interchange format. It can represent
4numbers, strings, ordered sequences of values, and collections of name/value
5pairs.
6
7[json-org]: http://json.org/
8
9JsonCpp is a C++ library that allows manipulating JSON values, including
10serialization and deserialization to and from strings. It can also preserve
11existing comment in unserialization/serialization steps, making it a convenient
12format to store user input files.
13
14## Release notes
15The 00.11.z branch is a new version, its major version number `00` is to shows that it is
16different from branch 0.y.z and 1.y.z. The main purpose of this branch is to give users a
17third choice, that is, users can only have a copy of the code, but can build in different environments,
18so it can be used with old or newer compilers.
19The benefit is that users can used some new features in this new branch that introduced in 1.y.z,
20but can hardly applied into 0.y.z.
21
22## Documentation
23
24[JsonCpp documentation][JsonCpp-documentation] is generated using [Doxygen][].
25
26[JsonCpp-documentation]: http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html
27[Doxygen]: http://www.doxygen.org
28
29
30## A note on backward-compatibility
31
32* `1.y.z` is built with C++11.
33* `0.y.z` can be used with older compilers.
34* `00.11.z` can be used with older compilers , with new features from `1.y.z`
35* Major versions maintain binary-compatibility.
36
37
38## Using JsonCpp in your project
39
40### The vcpkg dependency manager
41You can download and install JsonCpp using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
42
43    git clone https://github.com/Microsoft/vcpkg.git
44    cd vcpkg
45    ./bootstrap-vcpkg.sh
46    ./vcpkg integrate install
47    vcpkg install jsoncpp
48
49The JsonCpp port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
50
51### Amalgamated source
52https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)
53
54### The Meson Build System
55If you are using the [Meson Build System](http://mesonbuild.com), then you can get a wrap file by downloading it from [Meson WrapDB](https://wrapdb.mesonbuild.com/jsoncpp), or simply use `meson wrap install jsoncpp`.
56
57### Other ways
58If you have trouble, see the [Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question as an Issue.
59
60## License
61
62See the `LICENSE` file for details. In summary, JsonCpp is licensed under the
63MIT license, or public domain if desired and recognized in your jurisdiction.
64