# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 2018-03-04 00:26:30
# Node ID 66f2e622a2ed7895fe5ff2860e8e013d943b5b69
# Parent  624cbd1477a638991b1abbc588b0e308d6873f3f

fuzz: add a quick README to try and document how to test new fuzzers

Differential Revision: https://phab.mercurial-scm.org/D2633

diff --git a/contrib/fuzz/README.rst b/contrib/fuzz/README.rst
new file mode 100644
--- /dev/null
+++ b/contrib/fuzz/README.rst
@@ -0,0 +1,14 @@
+How to add fuzzers (partially cribbed from oss-fuzz[0]):
+
+  1) git clone https://github.com/google/oss-fuzz
+  2) cd oss-fuzz
+  3) python infra/helper.py build_image mercurial
+  4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \
+         gcr.io/oss-fuzz/mercurial bash
+  5) cd /src
+  6) rm -r mercurial
+  7) ln -s /hg-new mercurial
+  8) cd mercurial
+  9) compile
+
+0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md