@@ -80,7 +80,7 @@ Building and testing with SCons
80
80
** Note:** The SCons-based build system is deprecated. Please use CMake; see the
81
81
section above.
82
82
83
- JsonCpp can use [ Scons] [ ] as a build system. Note that SCons requires python to
83
+ JsonCpp can use [ Scons] [ ] as a build system. Note that SCons requires Python to
84
84
be installed.
85
85
86
86
[ SCons ] : http://www.scons.org/
@@ -139,7 +139,7 @@ In the instructions below, replace `path/to/jsontest` with the path of the
139
139
Building the documentation
140
140
--------------------------
141
141
142
- Run the python script ` doxybuild.py ` from the top directory:
142
+ Run the Python script ` doxybuild.py ` from the top directory:
143
143
144
144
python doxybuild.py --open --with-dot
145
145
@@ -150,25 +150,24 @@ Generating amalgamated source and header
150
150
----------------------------------------
151
151
152
152
JsonCpp is provided with a script to generate a single header and a single
153
- source file to ease inclusion in an existing project.
153
+ source file to ease inclusion into an existing project. The amalgamated source
154
+ can be generated at any time by running the following command from the
155
+ top-directory (this requires Python 2.6):
154
156
155
- The amalgamated source can be generated at any time by running the following
156
- command from the top-directory (requires python 2.6):
157
+ python amalgamate.py
157
158
158
- python amalgamate.py
159
+ It is possible to specify header name. See the ` -h ` option for detail.
159
160
160
- It is possible to specify header name. See -h options for detail. By default,
161
- the following files are generated:
162
- - dist/jsoncpp.cpp: source file that need to be added to your project
163
- - dist/json/json.h: header file corresponding to use in your project. It is
164
- equivalent to including json/json.h in non-amalgamated source. This header
165
- only depends on standard headers.
166
- - dist/json/json-forwards.h: header the provides forward declaration
167
- of all JsonCpp types. This typically what should be included in headers to
168
- speed-up compilation.
161
+ By default, the following files are generated:
162
+ * ` dist/jsoncpp.cpp ` : source file that needs to be added to your project.
163
+ * ` dist/json/json.h ` : corresponding header file for use in your project. It is
164
+ equivalent to including ` json/json.h ` in non-amalgamated source. This header
165
+ only depends on standard headers.
166
+ * ` dist/json/json-forwards.h ` : header that provides forward declaration of all
167
+ JsonCpp types.
169
168
170
169
The amalgamated sources are generated by concatenating JsonCpp source in the
171
- correct order and defining macro JSON_IS_AMALGAMATION to prevent inclusion
170
+ correct order and defining the macro ` JSON_IS_AMALGAMATION ` to prevent inclusion
172
171
of other headers.
173
172
174
173
Adding a reader/writer test
0 commit comments