generic-library/jsoncpp
1
0
Fork 0
mirror of https://github.com/open-source-parsers/jsoncpp.git synced 2024-12-12 10:03:51 +01:00
Code Issues Projects Releases Wiki Activity

Began converting the README to Markdown.

Browse Source
This commit is contained in:
Aaron Jacobs 2014-07-01 11:54:14 +10:00
parent 3a0c4fcc82
commit 4b687640cb
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.txt → README.md
View File

@ -1,5 +1,5 @@
* Introduction: Introduction
============= ------------
JSON (JavaScript Object Notation) is a lightweight data-interchange format. JSON (JavaScript Object Notation) is a lightweight data-interchange format.
It can represent integer, real number, string, an ordered sequence of It can represent integer, real number, string, an ordered sequence of
@ -13,8 +13,8 @@ making it a convenient format to store user input files.
Unserialization parsing is user friendly and provides precise error reports. Unserialization parsing is user friendly and provides precise error reports.
* Using json-cpp in your project: Using json-cpp in your project
=============================== ------------------------------
The recommended approach to integrate json-cpp in your project is to The recommended approach to integrate json-cpp in your project is to
build the the amalgamated source (a single .cpp) with your own build build the the amalgamated source (a single .cpp) with your own build
@ -31,8 +31,8 @@ json-cpp headers should be included as follow:
If json-cpp was build as a dynamic library on Windows, then your project If json-cpp was build as a dynamic library on Windows, then your project
need to define macro "JSON_DLL" to JSON_API should import exported symbols. need to define macro "JSON_DLL" to JSON_API should import exported symbols.
* Building/Testing with new CMake build system: Building/Testing with new CMake build system
============================================= --------------------------------------------
CMake is a C++ Makefiles/Solution generator that can be downloaded from: CMake is a C++ Makefiles/Solution generator that can be downloaded from:
http://www.cmake.org http://www.cmake.org
@ -71,8 +71,8 @@ Running "cmake -h" will display the list of available generators (passed as -G o
By default CMake hides compilation command-line. This can be modified by specifying: By default CMake hides compilation command-line. This can be modified by specifying:
-DCMAKE_VERBOSE_MAKEFILE=true when generating makefiles. -DCMAKE_VERBOSE_MAKEFILE=true when generating makefiles.
* Building/Testing with the legacy build system based on SCons: Building/Testing with the legacy build system based on SCons
============================================================= ------------------------------------------------------------
JsonCpp uses Scons (http://www.scons.org) as a build system. Scons requires JsonCpp uses Scons (http://www.scons.org) as a build system. Scons requires
python to be installed (http://www.python.org). python to be installed (http://www.python.org).
@ -105,8 +105,8 @@ to do so.
and TARGET may be: and TARGET may be:
check: build library and run unit tests. check: build library and run unit tests.
* Running the test manually: Running the test manually
========================== -------------------------
Notes that test can be run by scons using the 'check' target (see above). Notes that test can be run by scons using the 'check' target (see above).
@ -133,8 +133,8 @@ You can run the tests using valgrind:
python rununittests.py --valgrind "path to test_lib_json.exe" python rununittests.py --valgrind "path to test_lib_json.exe"
* Building the documentation: Building the documentation
=========================== --------------------------
Run the python script doxybuild.py from the top directory: Run the python script doxybuild.py from the top directory:
@ -146,8 +146,8 @@ Notes that the documentation is also available for download as a tarball.
The documentation of the latest release is available online at: The documentation of the latest release is available online at:
http://jsoncpp.sourceforge.net/ http://jsoncpp.sourceforge.net/
* Generating amalgamated source and header Generating amalgamated source and header
======================================== ----------------------------------------
JsonCpp is provided with a script to generate a single header and a single JsonCpp is provided with a script to generate a single header and a single
source file to ease inclusion in an existing project. source file to ease inclusion in an existing project.
@ -171,8 +171,8 @@ The amalgamated sources are generated by concatenating JsonCpp source in the
correct order and defining macro JSON_IS_AMALGAMATION to prevent inclusion correct order and defining macro JSON_IS_AMALGAMATION to prevent inclusion
of other headers. of other headers.
* Adding a reader/writer test: Adding a reader/writer test
============================ ---------------------------
To add a test, you need to create two files in test/data: To add a test, you need to create two files in test/data:
- a TESTNAME.json file, that contains the input document in JSON format. - a TESTNAME.json file, that contains the input document in JSON format.
@ -192,8 +192,8 @@ See test_complex_01.json and test_complex_01.expected to better understand
element path. element path.
* Understanding reader/writer test output: Understanding reader/writer test output
======================================== ---------------------------------------
When a test is run, output files are generated aside the input test files. When a test is run, output files are generated aside the input test files.
Below is a short description of the content of each file: Below is a short description of the content of each file:
@ -212,8 +212,8 @@ Below is a short description of the content of each file:
test_complex_01.process-output: jsontest.exe output, typically useful to test_complex_01.process-output: jsontest.exe output, typically useful to
understand parsing error. understand parsing error.
* License License
======= -------
See file LICENSE for details. Basically JsonCpp is licensed under See file LICENSE for details. Basically JsonCpp is licensed under
MIT license, or public domain if desired and recognized in your jurisdiction. MIT license, or public domain if desired and recognized in your jurisdiction.