From 95c22f569a4cb83733e5098c4501bd80e8fa1c13 Mon Sep 17 00:00:00 2001
From: Wilson Lin <code@wilsonl.in>
Date: Fri, 31 Jan 2020 23:38:58 +1100
Subject: [PATCH] Add READMEs

---
 .github/workflows/README.md |  3 +++
 fuzz/README.md              | 23 +++++++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 .github/workflows/README.md
 create mode 100644 fuzz/README.md

diff --git a/.github/workflows/README.md b/.github/workflows/README.md
new file mode 100644
index 0000000..2c2255c
--- /dev/null
+++ b/.github/workflows/README.md
@@ -0,0 +1,3 @@
+# GitHub Actions
+
+This folder contains various GitHub Actions that are run upon every new version Git tag is pushed to GitHub. They build, pack, and upload/deploy/publish packages and binaries for using the release in various programming languages and operating systems.
diff --git a/fuzz/README.md b/fuzz/README.md
new file mode 100644
index 0000000..8538ad1
--- /dev/null
+++ b/fuzz/README.md
@@ -0,0 +1,23 @@
+# Fuzzing
+
+This folder contains a Cargo package for a fuzz target that can be used for fuzzing with [american fuzzy lop](https://github.com/google/AFL). Fuzzing has found many rare bugs and unhandled edge cases that cause crashes and is invaluable for improving the reliability of hyperbuild.
+
+## Inputs
+
+Initial inputs can be found in the [in](./in) folder.
+
+## Building
+
+```bash
+cargo afl build
+```
+
+## Running
+
+```bash
+cargo afl fuzz -i in -o out target/debug/hyperbuild-fuzz-target
+```
+
+## Results
+
+Inputs that cause a crash are found in the `out/crashes` folder.