Fix jsoncpp.pc file
[platform/upstream/jsoncpp.git] / README.md
1 # JsonCpp
2
3 [![badge](https://img.shields.io/badge/conan.io-jsoncpp%2F1.8.0-green.svg?logo=data:image/png;base64%2CiVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAMAAAAolt3jAAAA1VBMVEUAAABhlctjlstkl8tlmMtlmMxlmcxmmcxnmsxpnMxpnM1qnc1sn85voM91oM11oc1xotB2oc56pNF6pNJ2ptJ8ptJ8ptN9ptN8p9N5qNJ9p9N9p9R8qtOBqdSAqtOAqtR%2BrNSCrNJ/rdWDrNWCsNWCsNaJs9eLs9iRvNuVvdyVv9yXwd2Zwt6axN6dxt%2Bfx%2BChyeGiyuGjyuCjyuGly%2BGlzOKmzOGozuKoz%2BKqz%2BOq0OOv1OWw1OWw1eWx1eWy1uay1%2Baz1%2Baz1%2Bez2Oe02Oe12ee22ujUGwH3AAAAAXRSTlMAQObYZgAAAAFiS0dEAIgFHUgAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfgBQkREyOxFIh/AAAAiklEQVQI12NgAAMbOwY4sLZ2NtQ1coVKWNvoc/Eq8XDr2wB5Ig62ekza9vaOqpK2TpoMzOxaFtwqZua2Bm4makIM7OzMAjoaCqYuxooSUqJALjs7o4yVpbowvzSUy87KqSwmxQfnsrPISyFzWeWAXCkpMaBVIC4bmCsOdgiUKwh3JojLgAQ4ZCE0AMm2D29tZwe6AAAAAElFTkSuQmCC)](https://bintray.com/theirix/conan-repo/jsoncpp%3Atheirix)
4 [![badge](https://img.shields.io/badge/license-MIT-blue)](https://github.com/open-source-parsers/jsoncpp/blob/master/LICENSE)
5 [![badge](https://img.shields.io/badge/document-doxygen-brightgreen)](http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html)
6 [![Coverage Status](https://coveralls.io/repos/github/open-source-parsers/jsoncpp/badge.svg?branch=master)](https://coveralls.io/github/open-source-parsers/jsoncpp?branch=master)
7
8
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.
12
13 [json-org]: http://json.org/
14
15 JsonCpp is a C++ library that allows manipulating JSON values, including
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.
19
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
28
29 ## A note on backward-compatibility
30
31 * `1.y.z` is built with C++11.
32 * `0.y.z` can be used with older compilers.
33 * Major versions maintain binary-compatibility.
34
35
36 ## Using JsonCpp in your project
37
38 ### The vcpkg dependency manager
39 You can download and install JsonCpp using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
40
41     git clone https://github.com/Microsoft/vcpkg.git
42     cd vcpkg
43     ./bootstrap-vcpkg.sh
44     ./vcpkg integrate install
45     vcpkg install jsoncpp
46
47 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.
48
49 ### Amalgamated source
50 https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)
51
52 ### The Meson Build System
53 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`.
54
55 ### Other ways
56 If you have trouble, see the [Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question as an Issue.
57
58 ## License
59
60 See the `LICENSE` file for details. In summary, JsonCpp is licensed under the
61 MIT license, or public domain if desired and recognized in your jurisdiction.