summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-08-13 22:41:26 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2014-08-13 22:56:33 -0700
commitd612fe464bfc7f298a790d2e2f4101f23244042d (patch)
tree6dde8313fc3abb3751e64ae1a790debd75f115e6
parentfb34178a06c0d10063270681d2a4125449fbc16a (diff)
README changes presupposing gh-pages site.
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index f5099e4..16ba35c 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
Standard markdown
=================
-Standard markdown is a specification of markdown syntax, together with
-implementations (`stmd`) in C and javascript.
+Standard markdown is a [specification of markdown syntax][the spec],
+together with implementations (`stmd`) in C and javascript.
The implementations
-------------------
@@ -25,15 +25,19 @@ version (using `node.js`) is also provided (`js/markdown`), and there is
a "dingus" for playing with it interactively. (`make dingus` will start
this.)
-The spec contains over 400 embedded examples which serve as conformance
+[Try it now!](http://jgm.github.io/stmd/js/)
+
+[The spec] contains over 400 embedded examples which serve as conformance
tests. To run the tests for `stmd`, do `make test`. To run them for
another markdown program, say `myprog`, do `make test PROG=myprog`. To
run the tests for `stmd.js`, do `make testjs`.
+[The spec]: http://jgm.github.io/stmd/spec.html
+
The spec
--------
-The source of the spec is `spec.txt`. This is basically a markdown
+The source of [the spec] is `spec.txt`. This is basically a markdown
file, with code examples written in a shorthand form:
.