From 2091909f6aaefea37b8688604262c28c8ea1e7d9 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 7 Nov 2014 11:15:18 -0800 Subject: Revised README with cmake instructions. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 24fe944..3f34901 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,29 @@ run the tests for `commonmark.js`, do `make testjs`. [The spec]: http://jgm.github.io/CommonMark/spec.html +Installing +---------- + +To install the C program (and shared library), [cmake] is required: + + mkdir build + cd build + cmake .. # optionally: -DCMAKE_INSTALL_PREFIX=path + make # executable will be created as build/src/cmake + make install + +To run tests: + + perl runtests.pl spec.txt build/src/cmark + +To build the javascript library: + + browserify --standalone commonmark js/lib/index.js -o js/commonmark.js + +To run tests: + + node js/test.js + The spec -------- @@ -197,3 +220,5 @@ github issues for questions and possibly open-ended discussions. Use the [github issue tracker](http://github.com/jgm/stmd/issues) only for simple, clear, actionable issues. +[cmake]: http://www.cmake.org/download/ + -- cgit v1.2.3