summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-06-17 09:13:50 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2015-06-17 09:13:50 -0700
commit1632a5a121c531c1b4fafb1c2058e964174c95ad (patch)
tree874f8a9be854f0eab33e11bd3e7ec7c4c4f5306d
parent2fa54428e2910d4f8d96e6a548db650d50613535 (diff)
Small changes to README and benchmark files.
-rw-r--r--README.md9
-rw-r--r--benchmarks.md11
2 files changed, 12 insertions, 8 deletions
diff --git a/README.md b/README.md
index ff0fa3f..019493a 100644
--- a/README.md
+++ b/README.md
@@ -19,11 +19,14 @@ documents.
Advantages of this library:
- **Portable.** The library and program are written in standard
- C99 and have no external dependencies. It has been tested with
+ C99 and have no external dependencies. They have been tested with
MSVC, gcc, tcc, and clang.
-- **Fast.** Performance is very good, on par with the fastest
- Markdown processors: see the [benchmarks].
+- **Fast.** cmark can render a Markdown version of *War and Peace* in
+ the blink of an eye (127 milliseconds on a ten year old laptop,
+ vs. 100-400 milliseconds for an eye blink). In our [benchmarks],
+ cmark is 10,000 times faster than the original `Markdown.pl`, and
+ on par with the very fastest available Markdown processors.
- **Accurate.** The library passes all CommonMark conformance tests.
diff --git a/benchmarks.md b/benchmarks.md
index 5f6bed1..df3fc93 100644
--- a/benchmarks.md
+++ b/benchmarks.md
@@ -1,6 +1,11 @@
# Benchmarks
-Some benchmarks, run on an ancient Thinkpad running Intel Core 2 Duo at 2GHz.
+Here are some benchmarks, run on an ancient Thinkpad running Intel
+Core 2 Duo at 2GHz. The input text is a 11MB Markdown file built by
+concatenating the Markdown sources of all the localizations of the
+first edition of
+[*Pro Git*](https://github.com/progit/progit/tree/master/en) by Scott
+Chacon.
|Implementation | Time (sec)|
|-------------------|-----------:|
@@ -19,10 +24,6 @@ Some benchmarks, run on an ancient Thinkpad running Intel Core 2 Duo at 2GHz.
To run these benchmarks, use `make bench PROG=/path/to/program`.
-The input text is a 11MB Markdown file built by concatenating the
-Markdown sources of all the localizations of the first edition of
-[*Pro Git*](https://github.com/progit/progit/tree/master/en) by Scott Chacon.
-
`time` is used to measure execution speed. The reported
time is the *difference* between the time to run the program
with the benchmark input and the time to run it with no input.