summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-07 11:15:18 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-07 11:15:18 -0800
commit2091909f6aaefea37b8688604262c28c8ea1e7d9 (patch)
tree454944e5338b06128aa2721b8788e1a68dd92fdb
parentdc31167e9d4053fa000f52163afe74ea9d6fc751 (diff)
Revised README with cmake instructions.
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
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/
+