Skip to content

Commit 4b68764

Browse files
committed
Began converting the README to Markdown.
1 parent 3a0c4fc commit 4b68764

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

README.txt renamed to README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
* Introduction:
2-
=============
1+
Introduction
2+
------------
33

44
JSON (JavaScript Object Notation) is a lightweight data-interchange format.
55
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.
1313

1414
Unserialization parsing is user friendly and provides precise error reports.
1515

16-
* Using json-cpp in your project:
17-
===============================
16+
Using json-cpp in your project
17+
------------------------------
1818

1919
The recommended approach to integrate json-cpp in your project is to
2020
build the the amalgamated source (a single .cpp) with your own build
@@ -31,8 +31,8 @@ json-cpp headers should be included as follow:
3131
If json-cpp was build as a dynamic library on Windows, then your project
3232
need to define macro "JSON_DLL" to JSON_API should import exported symbols.
3333

34-
* Building/Testing with new CMake build system:
35-
=============================================
34+
Building/Testing with new CMake build system
35+
--------------------------------------------
3636

3737
CMake is a C++ Makefiles/Solution generator that can be downloaded from:
3838
http://www.cmake.org
@@ -71,8 +71,8 @@ Running "cmake -h" will display the list of available generators (passed as -G o
7171
By default CMake hides compilation command-line. This can be modified by specifying:
7272
-DCMAKE_VERBOSE_MAKEFILE=true when generating makefiles.
7373

74-
* Building/Testing with the legacy build system based on SCons:
75-
=============================================================
74+
Building/Testing with the legacy build system based on SCons
75+
------------------------------------------------------------
7676

7777
JsonCpp uses Scons (http://www.scons.org) as a build system. Scons requires
7878
python to be installed (http://www.python.org).
@@ -105,8 +105,8 @@ to do so.
105105
and TARGET may be:
106106
check: build library and run unit tests.
107107

108-
* Running the test manually:
109-
==========================
108+
Running the test manually
109+
-------------------------
110110

111111
Notes that test can be run by scons using the 'check' target (see above).
112112

@@ -133,8 +133,8 @@ You can run the tests using valgrind:
133133
python rununittests.py --valgrind "path to test_lib_json.exe"
134134

135135

136-
* Building the documentation:
137-
===========================
136+
Building the documentation
137+
--------------------------
138138

139139
Run the python script doxybuild.py from the top directory:
140140

@@ -146,8 +146,8 @@ Notes that the documentation is also available for download as a tarball.
146146
The documentation of the latest release is available online at:
147147
http://jsoncpp.sourceforge.net/
148148

149-
* Generating amalgamated source and header
150-
========================================
149+
Generating amalgamated source and header
150+
----------------------------------------
151151

152152
JsonCpp is provided with a script to generate a single header and a single
153153
source file to ease inclusion in an existing project.
@@ -171,8 +171,8 @@ The amalgamated sources are generated by concatenating JsonCpp source in the
171171
correct order and defining macro JSON_IS_AMALGAMATION to prevent inclusion
172172
of other headers.
173173

174-
* Adding a reader/writer test:
175-
============================
174+
Adding a reader/writer test
175+
---------------------------
176176

177177
To add a test, you need to create two files in test/data:
178178
- 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
192192
element path.
193193

194194

195-
* Understanding reader/writer test output:
196-
========================================
195+
Understanding reader/writer test output
196+
---------------------------------------
197197

198198
When a test is run, output files are generated aside the input test files.
199199
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:
212212
test_complex_01.process-output: jsontest.exe output, typically useful to
213213
understand parsing error.
214214

215-
* License
216-
=======
215+
License
216+
-------
217217

218218
See file LICENSE for details. Basically JsonCpp is licensed under
219219
MIT license, or public domain if desired and recognized in your jurisdiction.

0 commit comments

Comments
 (0)