| Iñaki Baz Castillo | 60bfcf1 | 2017-01-12 09:57:34 | [diff] [blame] | 1 | # JsonCpp |
| Christopher Dunn | f986423 | 2007-06-14 21:01:26 | [diff] [blame] | 2 | |
| Willem | 863aa36 | 2019-03-18 13:02:50 | [diff] [blame] | 3 | [](https://bintray.com/theirix/conan-repo/jsoncpp%3Atheirix) |
| dota17 | c634b98 | 2019-10-25 09:12:11 | [diff] [blame] | 4 | [](https://github.com/open-source-parsers/jsoncpp/blob/master/LICENSE) |
| 5 | [](http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html) |
| dota17 | ff58fdc | 2019-11-07 07:25:06 | [diff] [blame] | 6 | [](https://coveralls.io/github/open-source-parsers/jsoncpp?branch=master) |
| dota17 | c634b98 | 2019-10-25 09:12:11 | [diff] [blame] | 7 | |
| paulo | 746ef15 | 2017-04-09 17:14:38 | [diff] [blame] | 8 | |
| Aaron Jacobs | ff22ca7 | 2014-07-01 01:56:56 | [diff] [blame] | 9 | [JSON][json-org] is a lightweight data-interchange format. It can represent |
| 10 | numbers, strings, ordered sequences of values, and collections of name/value |
| 11 | pairs. |
| Christopher Dunn | f986423 | 2007-06-14 21:01:26 | [diff] [blame] | 12 | |
| Aaron Jacobs | ff22ca7 | 2014-07-01 01:56:56 | [diff] [blame] | 13 | [json-org]: http://json.org/ |
| Christopher Dunn | f986423 | 2007-06-14 21:01:26 | [diff] [blame] | 14 | |
| Iñaki Baz Castillo | 60bfcf1 | 2017-01-12 09:57:34 | [diff] [blame] | 15 | JsonCpp is a C++ library that allows manipulating JSON values, including |
| Aaron Jacobs | ff22ca7 | 2014-07-01 01:56:56 | [diff] [blame] | 16 | serialization and deserialization to and from strings. It can also preserve |
| 17 | existing comment in unserialization/serialization steps, making it a convenient |
| 18 | format to store user input files. |
| Christopher Dunn | f986423 | 2007-06-14 21:01:26 | [diff] [blame] | 19 | |
| Iñaki Baz Castillo | 60bfcf1 | 2017-01-12 09:57:34 | [diff] [blame] | 20 | |
| 21 | ## Documentation |
| 22 | |
| 23 | [JsonCpp documentation][JsonCpp-documentation] is generated using [Doxygen][]. |
| 24 | |
| 25 | [JsonCpp-documentation]: http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html |
| 26 | [Doxygen]: http://www.doxygen.org |
| 27 | |
| Christopher Dunn | da0fcfb | 2015-02-12 17:18:23 | [diff] [blame] | 28 | |
| Christopher Dunn | 533dbe0 | 2014-11-03 18:39:01 | [diff] [blame] | 29 | ## A note on backward-compatibility |
| Iñaki Baz Castillo | 60bfcf1 | 2017-01-12 09:57:34 | [diff] [blame] | 30 | |
| Christopher Dunn | da0fcfb | 2015-02-12 17:18:23 | [diff] [blame] | 31 | * `1.y.z` is built with C++11. |
| Christopher Dunn | 2fc08b4 | 2015-03-06 03:45:42 | [diff] [blame] | 32 | * `0.y.z` can be used with older compilers. |
| Chen | d2d4c74 | 2020-04-30 10:05:17 | [diff] [blame] | 33 | * `00.11.z` can be used both in old and new compilers. |
| Christopher Dunn | da0fcfb | 2015-02-12 17:18:23 | [diff] [blame] | 34 | * Major versions maintain binary-compatibility. |
| Baptiste Lepilleur | 57ee0e3 | 2010-02-22 04:16:10 | [diff] [blame] | 35 | |
| Chen | d2d4c74 | 2020-04-30 10:05:17 | [diff] [blame] | 36 | ### Special note |
| 37 | The branch `00.11.z`is a new branch, its major version number `00` is to show that it is |
| 38 | different from `0.y.z` and `1.y.z`, the main purpose of this branch is to make a balance |
| 39 | between the other two branches. Thus, users can use some new features in this new branch |
| 40 | that introduced in 1.y.z, but can hardly applied into 0.y.z. |
| Baptiste Lepilleur | 7469f1d | 2010-04-20 21:35:19 | [diff] [blame] | 41 | |
| Christopher Dunn | d40f26d | 2017-08-27 20:16:43 | [diff] [blame] | 42 | ## Using JsonCpp in your project |
| 43 | |
| Griffin Downs | 7e97345 | 2019-10-01 19:53:42 | [diff] [blame] | 44 | ### The vcpkg dependency manager |
| 45 | You can download and install JsonCpp using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager: |
| 46 | |
| 47 | git clone https://github.com/Microsoft/vcpkg.git |
| 48 | cd vcpkg |
| 49 | ./bootstrap-vcpkg.sh |
| 50 | ./vcpkg integrate install |
| Edward Brey | b8cb888 | 2020-05-08 01:00:12 | [diff] [blame] | 51 | ./vcpkg install jsoncpp |
| Griffin Downs | 7e97345 | 2019-10-01 19:53:42 | [diff] [blame] | 52 | |
| 53 | The 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. |
| 54 | |
| Christopher Dunn | d40f26d | 2017-08-27 20:16:43 | [diff] [blame] | 55 | ### Amalgamated source |
| Jacob Bundgaard | 41ffff0 | 2019-10-18 18:06:56 | [diff] [blame] | 56 | https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated) |
| Christopher Dunn | d40f26d | 2017-08-27 20:16:43 | [diff] [blame] | 57 | |
| Kostiantyn Ponomarenko | 4bfa962 | 2018-10-18 17:12:46 | [diff] [blame] | 58 | ### The Meson Build System |
| 59 | If 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`. |
| 60 | |
| Christopher Dunn | d40f26d | 2017-08-27 20:16:43 | [diff] [blame] | 61 | ### Other ways |
| dota17 | c634b98 | 2019-10-25 09:12:11 | [diff] [blame] | 62 | If you have trouble, see the [Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question as an Issue. |
| Christopher Dunn | d40f26d | 2017-08-27 20:16:43 | [diff] [blame] | 63 | |
| Iñaki Baz Castillo | 60bfcf1 | 2017-01-12 09:57:34 | [diff] [blame] | 64 | ## License |
| 65 | |
| Aaron Jacobs | 47f1577 | 2014-07-01 03:13:46 | [diff] [blame] | 66 | See the `LICENSE` file for details. In summary, JsonCpp is licensed under the |
| Baptiste Lepilleur | 7469f1d | 2010-04-20 21:35:19 | [diff] [blame] | 67 | MIT license, or public domain if desired and recognized in your jurisdiction. |
