Add docs content overview

coc-cyqh · Dec 11, 2021 · 77ce31c · 77ce31c
1 parent 5ec91ad
commit 77ce31c
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 9 deletions.
diff --git a/dictionaries/README.md b/dictionaries/README.md
@@ -1,6 +1,6 @@
 # AFL++ dictionaries
 
-(See [../README.md](../README.md) for the general instruction manual.)
+For the general instruction manual, see [docs/README.md](../docs/README.md).
 
 This subdirectory contains a set of dictionaries that can be used in conjunction
 with the -x option to allow the fuzzer to effortlessly explore the grammar of

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# AFL++ documentation
+
+This is the overview of the AFL++ docs content.
+
+For general information on AFL++, see the
+[README.md of the repository](../README.md).
+
+Also take a look at our [FAQ.md](FAQ.md) and
+[best_practices.md](best_practices.md).
+
+## Fuzzing targets with the source code available
+
+You can find a quickstart for fuzzing targets with the source code available in
+the [README.md of the repository](../README.md#quick-start-fuzzing-with-afl).
+
+For in-depth information on the steps of the fuzzing process, see
+[fuzzing_in_depth.md](fuzzing_in_depth.md) or click on the following
+image to select a step.
+
+![Fuzzing process overview](https://raw.githubusercontent.com/AFLplusplus/AFLplusplus/dev/docs/resources/fuzzing_process_overview.drawio.svg "Fuzzing process overview")
+
+For further information on instrumentation, see the
+[READMEs in the instrumentation/ folder](../instrumentation/).
+
+## Fuzzing other targets
+
+To learn about fuzzing other targets, see:
+
+* Binary-only: [fuzzing_binary-only_targets.md](fuzzing_binary-only_targets.md)
+* GUI programs:
+  [best_practices.md#fuzzing-a-gui-program](best_practices.md#fuzzing-a-gui-program)
+* Libraries: [frida_mode/README.md](../frida_mode/README.md)
+* Network services:
+  [best_practices.md#fuzzing-a-network-service](best_practices.md#fuzzing-a-network-service)
+* Non-linux: [unicorn_mode/README.md](../unicorn_mode/README.md)
+
+## Additional information
+
+* Tools that help fuzzing with AFL++:
+  [third_party_tools.md](third_party_tools.md)
+* Tutorials: [tutorials.md](tutorials.md)
diff --git a/docs/afl-fuzz_approach.md b/docs/afl-fuzz_approach.md
@@ -40,7 +40,7 @@ superior to blind fuzzing or coverage-only tools.
 This section provides an overview of the status screen - plus tips for
 troubleshooting any warnings and red text shown in the UI.
 
-For the general instruction manual, see [README.md](../README.md).
+For the general instruction manual, see [README.md](README.md).
 
 ### A note about colors
 

diff --git a/docs/resources/fuzzing_process_overview.drawio.svg b/docs/resources/fuzzing_process_overview.drawio.svg
diff --git a/instrumentation/README.gcc_plugin.md b/instrumentation/README.gcc_plugin.md
@@ -1,7 +1,8 @@
 # GCC-based instrumentation for afl-fuzz
 
-For the general instruction manual, see [../README.md](../README.md). For the
-LLVM-based instrumentation, see [README.llvm.md](README.llvm.md).
+For the general instruction manual, see [docs/README.md](../docs/README.md).
+
+For the LLVM-based instrumentation, see [README.llvm.md](README.llvm.md).
 
 This document describes how to build and use `afl-gcc-fast` and `afl-g++-fast`,
 which instrument the target with the help of gcc plugins.

diff --git a/instrumentation/README.llvm.md b/instrumentation/README.llvm.md
@@ -1,6 +1,6 @@
 # Fast LLVM-based instrumentation for afl-fuzz
 
-For the general instruction manual, see [../README.md](../README.md).
+For the general instruction manual, see [docs/README.md](../docs/README.md).
 
 For the GCC-based instrumentation, see
 [README.gcc_plugin.md](README.gcc_plugin.md).

diff --git a/qemu_mode/README.md b/qemu_mode/README.md
@@ -1,6 +1,6 @@
 # High-performance binary-only instrumentation for afl-fuzz
 
-For the general instruction manual, see [README.md](../README.md).
+For the general instruction manual, see [docs/README.md](../docs/README.md).
 
 ## 1) Introduction
 

diff --git a/testcases/README.md b/testcases/README.md
@@ -1,6 +1,6 @@
 # AFL++ starting test cases
 
-  (See [../README.md](../README.md) for the general instruction manual.)
+For the general instruction manual, see [docs/README.md](../docs/README.md).
 
 The archives/, images/, multimedia/, and others/ subdirectories contain small,
 standalone files that can be used to seed afl-fuzz when testing parsers for a

diff --git a/utils/libdislocator/README.md b/utils/libdislocator/README.md
@@ -1,6 +1,6 @@
 # libdislocator, an abusive allocator
 
-  (See ../../README.md for the general instruction manual.)
+For the general instruction manual, see [docs/README.md](../../docs/README.md).
 
 This is a companion library that can be used as a drop-in replacement for the
 libc allocator in the fuzzed binaries. It improves the odds of bumping into

diff --git a/utils/libtokencap/README.md b/utils/libtokencap/README.md
@@ -5,7 +5,7 @@
  The afl-clang-fast AFL_LLVM_DICT2FILE feature is much better, afl-clang-lto
  has that feature automatically integrated.
 
-  (See ../../README.md for the general instruction manual.)
+For the general instruction manual, see [docs/README.md](../../docs/README.md).
 
 This companion library allows you to instrument `strcmp()`, `memcmp()`,
 and related functions to automatically extract syntax tokens passed to any of