From d40f26d4720e51d51b847f5a58be5b39d6a664a9 Mon Sep 17 00:00:00 2001 From: Christopher Dunn Date: Sun, 27 Aug 2017 15:16:43 -0500 Subject: [PATCH] Move amalgamated source details to wiki --- README.md | 49 ++++++++----------------------------------------- 1 file changed, 8 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index f560985..6c5cf07 100644 --- a/README.md +++ b/README.md @@ -28,47 +28,6 @@ format to store user input files. * `0.y.z` can be used with older compilers. * Major versions maintain binary-compatibility. - -## Using JsonCpp in your project - -The recommended approach to integrating JsonCpp in your project is to include -the [amalgamated source](#generating-amalgamated-source-and-header) (a single -`.cpp` file and two `.h` files) in your project, and compile and build as you -would any other source file. This ensures consistency of compilation flags and -ABI compatibility, issues which arise when building shared or static -libraries. See the next section for instructions. - -The `include/` should be added to your compiler include path. JsonCpp headers -should be included as follow: - - #include - -If JsonCpp was built as a dynamic library on Windows, then your project needs to define the macro `JSON_DLL`. - -### Generating amalgamated source and header - -JsonCpp is provided with a script to generate a single header and a single -source file to ease inclusion into an existing project. The amalgamated source -can be generated at any time by running the following command from the -top-directory (this requires Python 2.6): - - python amalgamate.py - -It is possible to specify header name. See the `-h` option for detail. - -By default, the following files are generated: - -* `dist/jsoncpp.cpp`: source file that needs to be added to your project. -* `dist/json/json.h`: corresponding header file for use in your project. It is - equivalent to including `json/json.h` in non-amalgamated source. This header - only depends on standard headers. -* `dist/json/json-forwards.h`: header that provides forward declaration of all - JsonCpp types. - -The amalgamated sources are generated by concatenating JsonCpp source in the -correct order and defining the macro `JSON_IS_AMALGAMATION` to prevent inclusion of other headers. - - ## Contributing to JsonCpp ### 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 * `test_complex_01.process-output`: `jsontest` output, typically useful for understanding parsing errors. +## Using JsonCpp in your project + +### Amalgamated source +https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated + +### Other ways +If you have trouble, see the Wiki, or post a question as an Issue. + ## License See the `LICENSE` file for details. In summary, JsonCpp is licensed under the