summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-06-17 09:20:30 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2015-06-17 09:20:45 -0700
commitcc2effd9aca0eb3cc78810d10b99d3d7b7424ad9 (patch)
treedc797ae68e8901dc6c70f3a8c993e318f1f94d32 /README.md
parent1632a5a121c531c1b4fafb1c2058e964174c95ad (diff)
README: added 'make afl' instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index 019493a..b9be9b1 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Advantages of this library:
will be rendered on the server using `cmark`.
- **Robust.** The library has been extensively fuzz-tested using
- american fuzzy lop. The test suite includes pathological cases
+ [american fuzzy lop]. The test suite includes pathological cases
that bring many other Markdown parsers to a crawl (for example,
thousands-deep nested bracketed text or block quotes).
@@ -99,10 +99,6 @@ To run a benchmark:
make bench
-To run a "fuzz test" against ten long randomly generated inputs:
-
- make fuzztest
-
To run a test for memory leaks using `valgrind`:
make leakcheck
@@ -111,6 +107,14 @@ To reformat source code using `astyle`:
make astyle
+To run a "fuzz test" against ten long randomly generated inputs:
+
+ make fuzztest
+
+To do a more systematic fuzz test with [american fuzzy lop]:
+
+ AFL_PATH=/path/to/afl_directory make afl
+
To make a release tarball and zip archive:
make archive
@@ -172,3 +176,4 @@ most of the C library's API and its test harness.
[commonmark.js]: https://github.com/jgm/commonmark.js
[Build Status]: https://img.shields.io/travis/jgm/cmark/master.svg?style=flat
[Windows Build Status]: https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true
+[american fuzzy lop]: http://lcamtuf.coredump.cx/afl/