Skip to content

Commit da0fcfb

Browse files
committed
link web docs
1 parent 3ebba5c commit da0fcfb

File tree

2 files changed

+15
-28
lines changed

2 files changed

+15
-28
lines changed

README.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,20 @@ pairs.
77

88
[json-org]: http://json.org/
99

10-
JsonCpp is a C++ library that allows manipulating JSON values, including
10+
[JsonCpp][] is a C++ library that allows manipulating JSON values, including
1111
serialization and deserialization to and from strings. It can also preserve
1212
existing comment in unserialization/serialization steps, making it a convenient
1313
format to store user input files.
1414

15+
[JsonCpp]: http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html
16+
1517
## A note on backward-compatibility
16-
Very soon, we are switching to C++11 only. For older compilers, try the `pre-C++11` branch.
18+
* `1.y.z` is built with C++11.
19+
* `0.8.z` can be used with older compilers.
20+
* Major versions maintain binary-compatibility.
1721

1822
Using JsonCpp in your project
1923
-----------------------------
20-
2124
The recommended approach to integrating JsonCpp in your project is to build
2225
the amalgamated source (a single `.cpp` file) with your own build system. This
2326
ensures consistency of compilation flags and ABI compatibility. See the section
@@ -28,13 +31,11 @@ should be included as follow:
2831

2932
#include <json/json.h>
3033

31-
If JsonCpp was build as a dynamic library on Windows, then your project needs to
34+
If JsonCpp was built as a dynamic library on Windows, then your project needs to
3235
define the macro `JSON_DLL`.
3336

34-
35-
Building and testing with new CMake
36-
-----------------------------------
37-
37+
Building and testing with CMake
38+
-------------------------------
3839
[CMake][] is a C++ Makefiles/Solution generator. It is usually available on most
3940
Linux system as package. On Ubuntu:
4041

@@ -75,10 +76,8 @@ the `-G` option).
7576
By default CMake hides compilation commands. This can be modified by specifying
7677
`-DCMAKE_VERBOSE_MAKEFILE=true` when generating makefiles.
7778

78-
7979
Building and testing with SCons
8080
-------------------------------
81-
8281
**Note:** The SCons-based build system is deprecated. Please use CMake; see the
8382
section above.
8483

@@ -107,14 +106,7 @@ If you are building with Microsoft Visual Studio 2008, you need to set up the
107106
environment by running `vcvars32.bat` (e.g. MSVC 2008 command prompt) before
108107
running SCons.
109108

110-
111-
Running the tests manually
112-
--------------------------
113-
114-
Note that test can be run using SCons using the `check` target:
115-
116-
scons platform=$PLATFORM check
117-
109+
# Running the tests manually
118110
You need to run tests manually only if you are troubleshooting an issue.
119111

120112
In the instructions below, replace `path/to/jsontest` with the path of the
@@ -137,20 +129,21 @@ In the instructions below, replace `path/to/jsontest` with the path of the
137129
# You can run the tests using valgrind:
138130
python rununittests.py --valgrind path/to/test_lib_json
139131

132+
## Running the tests using scons
133+
Note that tests can be run using SCons using the `check` target:
134+
135+
scons platform=$PLATFORM check
140136

141137
Building the documentation
142138
--------------------------
143-
144139
Run the Python script `doxybuild.py` from the top directory:
145140

146141
python doxybuild.py --doxygen=$(which doxygen) --open --with-dot
147142

148143
See `doxybuild.py --help` for options.
149144

150-
151145
Generating amalgamated source and header
152146
----------------------------------------
153-
154147
JsonCpp is provided with a script to generate a single header and a single
155148
source file to ease inclusion into an existing project. The amalgamated source
156149
can be generated at any time by running the following command from the
@@ -172,10 +165,8 @@ The amalgamated sources are generated by concatenating JsonCpp source in the
172165
correct order and defining the macro `JSON_IS_AMALGAMATION` to prevent inclusion
173166
of other headers.
174167

175-
176168
Adding a reader/writer test
177169
---------------------------
178-
179170
To add a test, you need to create two files in test/data:
180171

181172
* a `TESTNAME.json` file, that contains the input document in JSON format.
@@ -195,10 +186,8 @@ The `TESTNAME.expected` file format is as follows:
195186
See the examples `test_complex_01.json` and `test_complex_01.expected` to better
196187
understand element paths.
197188

198-
199189
Understanding reader/writer test output
200190
---------------------------------------
201-
202191
When a test is run, output files are generated beside the input test files.
203192
Below is a short description of the content of each file:
204193

@@ -215,10 +204,7 @@ Below is a short description of the content of each file:
215204
* `test_complex_01.process-output`: `jsontest` output, typically useful for
216205
understanding parsing errors.
217206

218-
219207
License
220208
-------
221-
222209
See the `LICENSE` file for details. In summary, JsonCpp is licensed under the
223210
MIT license, or public domain if desired and recognized in your jurisdiction.
224-

doc/jsoncpp.dox

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ Basically JsonCpp is licensed under MIT license, or public domain if desired
152152
and recognized in your jurisdiction.
153153

154154
\author Baptiste Lepilleur <[email protected]> (originator)
155+
\author Christopher Dunn <[email protected]> (primary maintainer)
155156
\version \include version
156157
We make strong guarantees about binary-compatibility, consistent with
157158
<a href="http://apr.apache.org/versioning.html">the Apache versioning scheme</a>.

0 commit comments

Comments
 (0)