Skip to content

Commit d40f26d

Browse files
committed
Move amalgamated source details to wiki
1 parent c668af9 commit d40f26d

File tree

1 file changed

+8
-41
lines changed

1 file changed

+8
-41
lines changed

README.md

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -28,47 +28,6 @@ format to store user input files.
2828
* `0.y.z` can be used with older compilers.
2929
* Major versions maintain binary-compatibility.
3030

31-
32-
## Using JsonCpp in your project
33-
34-
The recommended approach to integrating JsonCpp in your project is to include
35-
the [amalgamated source](#generating-amalgamated-source-and-header) (a single
36-
`.cpp` file and two `.h` files) in your project, and compile and build as you
37-
would any other source file. This ensures consistency of compilation flags and
38-
ABI compatibility, issues which arise when building shared or static
39-
libraries. See the next section for instructions.
40-
41-
The `include/` should be added to your compiler include path. JsonCpp headers
42-
should be included as follow:
43-
44-
#include <json/json.h>
45-
46-
If JsonCpp was built as a dynamic library on Windows, then your project needs to define the macro `JSON_DLL`.
47-
48-
### Generating amalgamated source and header
49-
50-
JsonCpp is provided with a script to generate a single header and a single
51-
source file to ease inclusion into an existing project. The amalgamated source
52-
can be generated at any time by running the following command from the
53-
top-directory (this requires Python 2.6):
54-
55-
python amalgamate.py
56-
57-
It is possible to specify header name. See the `-h` option for detail.
58-
59-
By default, the following files are generated:
60-
61-
* `dist/jsoncpp.cpp`: source file that needs to be added to your project.
62-
* `dist/json/json.h`: corresponding header file for use in your project. It is
63-
equivalent to including `json/json.h` in non-amalgamated source. This header
64-
only depends on standard headers.
65-
* `dist/json/json-forwards.h`: header that provides forward declaration of all
66-
JsonCpp types.
67-
68-
The amalgamated sources are generated by concatenating JsonCpp source in the
69-
correct order and defining the macro `JSON_IS_AMALGAMATION` to prevent inclusion of other headers.
70-
71-
7231
## Contributing to JsonCpp
7332

7433
### Building and testing with Meson/Ninja
@@ -158,6 +117,14 @@ When a test is run, output files are generated beside the input test files. Belo
158117
* `test_complex_01.process-output`: `jsontest` output, typically useful for
159118
understanding parsing errors.
160119

120+
## Using JsonCpp in your project
121+
122+
### Amalgamated source
123+
https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated
124+
125+
### Other ways
126+
If you have trouble, see the Wiki, or post a question as an Issue.
127+
161128
## License
162129

163130
See the `LICENSE` file for details. In summary, JsonCpp is licensed under the

0 commit comments

Comments
 (0)