summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-12 07:43:17 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-12 07:43:17 -0800
commit2810f421ae10869f50ee9b95c3260e3d38734306 (patch)
tree3475860ffd4123f3654567c04b3e35341c71cacc /README.md
parent51210a15c3479fccf7c4735f70e0c1a3b6085e8f (diff)
Added cmake test target.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index c83611e..ff75eb7 100644
--- a/README.md
+++ b/README.md
@@ -52,8 +52,8 @@ untrusted user input, you must run the output through an HTML
sanitizer to protect against
[XSS attacks](http://en.wikipedia.org/wiki/Cross-site_scripting).
-Installing
-----------
+Installing (C)
+--------------
Building the C program (`cmark`) and shared library (`libcmark`)
requires [cmake] and [re2c], which is used to generate `scanners.c` from
@@ -79,10 +79,17 @@ To run tests:
make test
-or
+or:
perl runtests.pl spec.txt build/src/cmark
+or (in the cmake build directory):
+
+ ctest -V
+
+Installing (JavaScript)
+-----------------------
+
The JavaScript library can be installed through `npm`:
npm install commonmark
@@ -102,9 +109,6 @@ or
node js/test.js
-`make dingus` will start an interactive dingus you can use to
-play with the JavaScript implementation:
-
The spec
--------