Skip to content

Commit 58edee4

Browse files
committed
Cleanup README.md, fix broken link.
1 parent b511d9e commit 58edee4

File tree

1 file changed

+35
-17
lines changed

1 file changed

+35
-17
lines changed

README.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![badge](https://img.shields.io/badge/document-doxygen-brightgreen)](http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html)
66
[![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)
77

8-
98
[JSON][json-org] is a lightweight data-interchange format. It can represent
109
numbers, strings, ordered sequences of values, and collections of name/value
1110
pairs.
@@ -14,18 +13,16 @@ pairs.
1413

1514
JsonCpp is a C++ library that allows manipulating JSON values, including
1615
serialization and deserialization to and from strings. It can also preserve
17-
existing comment in unserialization/serialization steps, making it a convenient
16+
existing comment in deserialization/serialization steps, making it a convenient
1817
format to store user input files.
1918

20-
2119
## Documentation
2220

2321
[JsonCpp documentation][JsonCpp-documentation] is generated using [Doxygen][].
2422

2523
[JsonCpp-documentation]: http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html
2624
[Doxygen]: http://www.doxygen.org
2725

28-
2926
## A note on backward-compatibility
3027

3128
* `1.y.z` is built with C++11.
@@ -34,42 +31,63 @@ format to store user input files.
3431
* Major versions maintain binary-compatibility.
3532

3633
### 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.
34+
35+
The branch `00.11.z`is a new branch, its major version number `00` is to show
36+
that it is different from `0.y.z` and `1.y.z`, the main purpose of this branch
37+
is to make a balance between the other two branches. Thus, users can use some
38+
new features in this new branch that introduced in 1.y.z, but can hardly applied
39+
into 0.y.z.
4140

4241
## Using JsonCpp in your project
4342

4443
### The vcpkg dependency manager
45-
You can download and install JsonCpp using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
4644

45+
You can download and install JsonCpp using the [vcpkg](https://github.com/Microsoft/vcpkg/)
46+
dependency manager:
47+
48+
```sh
4749
git clone https://github.com/Microsoft/vcpkg.git
4850
cd vcpkg
4951
./bootstrap-vcpkg.sh
5052
./vcpkg integrate install
5153
./vcpkg install jsoncpp
54+
```
5255

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.
56+
The JsonCpp port in vcpkg is kept up to date by Microsoft team members and
57+
community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg)
58+
on the vcpkg repository.
5459

5560
### Conan package manager
5661

57-
You can download and install JsonCpp using the [Conan](https://conan.io/) package manager:
62+
You can download and install JsonCpp using the [Conan](https://conan.io/)
63+
package manager:
5864

65+
```sh
5966
conan install -r conancenter --requires="jsoncpp/[*]" --build=missing
67+
```
6068

61-
The JsonCpp package in Conan Center is kept up to date by [ConanCenterIndex](https://github.com/conan-io/conan-center-index) contributors. If the version is out of date, please create an issue or pull request on the Conan Center Index repository.
69+
The JsonCpp package in Conan Center is kept up to date by [ConanCenterIndex](https://github.com/conan-io/conan-center-index)
70+
contributors. If the version is out of date, please create an issue or pull request on the
71+
Conan Center Index repository.
6272

6373
### Amalgamated source
64-
https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)
74+
75+
See the [Wiki entry on Amalgamated Source](https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)).
6576

6677
### The Meson Build System
67-
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`.
78+
79+
If you are using the [Meson Build System](http://mesonbuild.com), then you can
80+
get a wrap file by downloading it from [Meson WrapDB](https://mesonbuild.com/Wrapdb-projects.html),
81+
or simply use `meson wrap install jsoncpp`.
6882

6983
### Other ways
70-
If you have trouble, see the [Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question as an Issue.
84+
85+
If you have trouble, see the
86+
[Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question
87+
as an Issue.
7188

7289
## License
7390

74-
See the `LICENSE` file for details. In summary, JsonCpp is licensed under the
75-
MIT license, or public domain if desired and recognized in your jurisdiction.
91+
See the [LICENSE](./LICENSE) file for details. In summary, JsonCpp is licensed
92+
under the MIT license, or public domain if desired and recognized in your
93+
jurisdiction.

0 commit comments

Comments
 (0)