Skip to content

Commit

Permalink
README: added 'make afl' instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
jgm committed Jun 17, 2015
1 parent 1632a5a commit cc2effd
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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/

0 comments on commit cc2effd

Please sign in to comment.