summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-12-03 08:57:19 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-12-03 08:57:19 -0800
commitab68771467427229e629d1d2524e054bd45e859a (patch)
treebc76d33db50867a4aa15af5df3a481e72dbcacde /README.md
parent366af1187ad409b2fca12cd7a2b939019727db7d (diff)
Revised README's instructions on tests.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 10 insertions, 14 deletions
diff --git a/README.md b/README.md
index c3d7ae9..38b9d00 100644
--- a/README.md
+++ b/README.md
@@ -73,17 +73,6 @@ Or, to create Xcode project files on OSX:
make test
make install
-Tests can also be run manually on any executable `$PROG` using:
-
- python test/spec_tests.py --program $PROG
-
-If you want to extract the raw test data from the spec without
-actually running the tests, you can do:
-
- python test/spec_tests.py --dump-tests
-
-and you'll get all the tests in JSON format.
-
The GNU Makefile also provides a few other targets for developers.
To run a "fuzz test" against ten long randomly generated inputs:
@@ -141,9 +130,16 @@ The spec
--------
[The spec] contains over 500 embedded examples which serve as conformance
-tests. To run the tests for `cmark`, do `make test`. To run them for
-another Markdown program, say `myprog`, do `make test PROG=myprog`. To
-run the tests for `commonmark.js`, do `make testjs`.
+tests. To run the tests using an executable `$PROG`:
+
+ python test/spec_tests.py --program $PROG
+
+If you want to extract the raw test data from the spec without
+actually running the tests, you can do:
+
+ python test/spec_tests.py --dump-tests
+
+and you'll get all the tests in JSON format.
[The spec]: http://jgm.github.io/CommonMark/spec.html