Skip to content

Commit 8d0f8d0

Browse files
committed
Gave the testing section a makeover.
1 parent 49ed6c9 commit 8d0f8d0

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ be installed.
8787

8888
Invoke SCons as follows:
8989

90-
scons platform=PLTFRM [TARGET]
90+
scons platform=$PLATFORM [TARGET]
9191

92-
where `PLTFRM` may be one of:
92+
where `$PLATFORM` may be one of:
9393

9494
* `suncc`: Sun C++ (Solaris)
9595
* `vacpp`: Visual Age C++ (AIX)
@@ -106,32 +106,34 @@ environment by running `vcvars32.bat` (e.g. MSVC 2008 command prompt) before
106106
running SCons.
107107

108108

109-
Running the test manually
110-
-------------------------
111-
112-
Notes that test can be run by scons using the 'check' target (see above).
113-
114-
You need to run test manually only if you are troubleshooting an issue.
109+
Running the tests manually
110+
--------------------------
115111

116-
In the instruction below, replace "path to jsontest.exe" with the path
117-
of the 'jsontest' executable that was compiled on your platform.
118-
119-
cd test
120-
# This will run the Reader/Writer tests
121-
python runjsontests.py "path to jsontest.exe"
122-
123-
# This will run the Reader/Writer tests, using JSONChecker test suite
124-
# (http://www.json.org/JSON_checker/).
125-
# Notes: not all tests pass: JsonCpp is too lenient (for example,
126-
# it allows an integer to start with '0'). The goal is to improve
127-
# strict mode parsing to get all tests to pass.
128-
python runjsontests.py --with-json-checker "path to jsontest.exe"
129-
130-
# This will run the unit tests (mostly Value)
131-
python rununittests.py "path to test_lib_json.exe"
132-
133-
You can run the tests using valgrind:
134-
python rununittests.py --valgrind "path to test_lib_json.exe"
112+
Note that test can be run using SCons using the `check` target:
113+
114+
scons platform=$PLATFORM check
115+
116+
You need to run tests manually only if you are troubleshooting an issue.
117+
118+
In the instructions below, replace `path/to/jsontest` with the path of the
119+
`jsontest` executable that was compiled on your platform.
120+
121+
cd test
122+
# This will run the Reader/Writer tests
123+
python runjsontests.py path/to/jsontest
124+
125+
# This will run the Reader/Writer tests, using JSONChecker test suite
126+
# (http://www.json.org/JSON_checker/).
127+
# Notes: not all tests pass: JsonCpp is too lenient (for example,
128+
# it allows an integer to start with '0'). The goal is to improve
129+
# strict mode parsing to get all tests to pass.
130+
python runjsontests.py --with-json-checker path/to/jsontest
131+
132+
# This will run the unit tests (mostly Value)
133+
python rununittests.py path/to/test_lib_json
134+
135+
# You can run the tests using valgrind:
136+
python rununittests.py --valgrind path/to/test_lib_json
135137

136138

137139
Building the documentation

0 commit comments

Comments
 (0)