Add READMEs

This commit is contained in:
Wilson Lin 2020-01-31 23:38:58 +11:00
parent 934eb7a22d
commit 95c22f569a
2 changed files with 26 additions and 0 deletions

3
.github/workflows/README.md vendored Normal file
View File

@ -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.

23
fuzz/README.md Normal file
View File

@ -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.