aboutsummaryrefslogtreecommitdiff
path: root/src/README.md
diff options
context:
space:
mode:
authorDominik Maier <domenukk@gmail.com>2020-03-31 03:41:51 +0200
committerDominik Maier <domenukk@gmail.com>2020-03-31 03:41:51 +0200
commit3914aec72f0c0e9eb57a5b2b026e1522763d6bad (patch)
tree6352e8ba169e218988057fa62dd301d9f4dd4db9 /src/README.md
parent9b63fc758e9a296eabaa2f452f2d72e204db1240 (diff)
downloadafl++-3914aec72f0c0e9eb57a5b2b026e1522763d6bad.tar.gz
src doku is now markdown
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 00000000..6da534c3
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,24 @@
+# Source Folder
+
+Quick explanation about the files here:
+
+- `afl-analyze.c` - afl-analyze binary tool
+- `afl-as.c` - afl-as binary tool
+- `afl-gotcpu.c` - afl-gotcpu binary tool
+- `afl-showmap.c` - afl-showmap binary tool
+- `afl-tmin.c` - afl-tmin binary tool
+- `afl-fuzz.c` - afl-fuzz binary tool (just main() and usage())
+- `afl-fuzz-bitmap.c` - afl-fuzz bitmap handling
+- `afl-fuzz-extras.c` - afl-fuzz the *extra* function calls
+- `afl-fuzz-state.c` - afl-fuzz state and globals
+- `afl-fuzz-init.c` - afl-fuzz initialization
+- `afl-fuzz-misc.c` - afl-fuzz misc functions
+- `afl-fuzz-one.c` - afl-fuzz fuzzer_one big loop, this is where the mutation is happening
+- `afl-fuzz-python.c` - afl-fuzz the python mutator extension
+- `afl-fuzz-queue.c` - afl-fuzz handling the queue
+- `afl-fuzz-run.c` - afl-fuzz running the target
+- `afl-fuzz-stats.c` - afl-fuzz writing the statistics file
+- `afl-gcc.c` - afl-gcc binary tool (deprecated)
+- `afl-common.c` - common functions, used by afl-analyze, afl-fuzz, afl-showmap and afl-tmin
+- `afl-forkserver.c` - forkserver implementation, used by afl-fuzz and afl-tmin
+afl-sharedmem.c - sharedmem implementation, used by afl-fuzz and afl-tmin