Skip to content

Commit 77ce31c

Browse files
llzmbllzmb
committed
Add docs content overview
1 parent 5ec91ad commit 77ce31c

File tree

10 files changed

+55
-9
lines changed

10 files changed

+55
-9
lines changed

‎dictionaries/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AFL++ dictionaries
22

3-
(See [../README.md](../README.md) for the general instruction manual.)
3+
For the general instruction manual, see [docs/README.md](../docs/README.md).
44

55
This subdirectory contains a set of dictionaries that can be used in conjunction
66
with the -x option to allow the fuzzer to effortlessly explore the grammar of

‎docs/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AFL++ documentation
2+
3+
This is the overview of the AFL++ docs content.
4+
5+
For general information on AFL++, see the
6+
[README.md of the repository](../README.md).
7+
8+
Also take a look at our [FAQ.md](FAQ.md) and
9+
[best_practices.md](best_practices.md).
10+
11+
## Fuzzing targets with the source code available
12+
13+
You can find a quickstart for fuzzing targets with the source code available in
14+
the [README.md of the repository](../README.md#quick-start-fuzzing-with-afl).
15+
16+
For in-depth information on the steps of the fuzzing process, see
17+
[fuzzing_in_depth.md](fuzzing_in_depth.md) or click on the following
18+
image to select a step.
19+
20+
![Fuzzing process overview](https://raw.githubusercontent.com/AFLplusplus/AFLplusplus/dev/docs/resources/fuzzing_process_overview.drawio.svg "Fuzzing process overview")
21+
22+
For further information on instrumentation, see the
23+
[READMEs in the instrumentation/ folder](../instrumentation/).
24+
25+
## Fuzzing other targets
26+
27+
To learn about fuzzing other targets, see:
28+
29+
* Binary-only: [fuzzing_binary-only_targets.md](fuzzing_binary-only_targets.md)
30+
* GUI programs:
31+
[best_practices.md#fuzzing-a-gui-program](best_practices.md#fuzzing-a-gui-program)
32+
* Libraries: [frida_mode/README.md](../frida_mode/README.md)
33+
* Network services:
34+
[best_practices.md#fuzzing-a-network-service](best_practices.md#fuzzing-a-network-service)
35+
* Non-linux: [unicorn_mode/README.md](../unicorn_mode/README.md)
36+
37+
## Additional information
38+
39+
* Tools that help fuzzing with AFL++:
40+
[third_party_tools.md](third_party_tools.md)
41+
* Tutorials: [tutorials.md](tutorials.md)

‎docs/afl-fuzz_approach.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ superior to blind fuzzing or coverage-only tools.
4040
This section provides an overview of the status screen - plus tips for
4141
troubleshooting any warnings and red text shown in the UI.
4242

43-
For the general instruction manual, see [README.md](../README.md).
43+
For the general instruction manual, see [README.md](README.md).
4444

4545
### A note about colors
4646

‎docs/resources/fuzzing_process_overview.drawio.svg

+4
Loading

‎instrumentation/README.gcc_plugin.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# GCC-based instrumentation for afl-fuzz
22

3-
For the general instruction manual, see [../README.md](../README.md). For the
4-
LLVM-based instrumentation, see [README.llvm.md](README.llvm.md).
3+
For the general instruction manual, see [docs/README.md](../docs/README.md).
4+
5+
For the LLVM-based instrumentation, see [README.llvm.md](README.llvm.md).
56

67
This document describes how to build and use `afl-gcc-fast` and `afl-g++-fast`,
78
which instrument the target with the help of gcc plugins.

‎instrumentation/README.llvm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fast LLVM-based instrumentation for afl-fuzz
22

3-
For the general instruction manual, see [../README.md](../README.md).
3+
For the general instruction manual, see [docs/README.md](../docs/README.md).
44

55
For the GCC-based instrumentation, see
66
[README.gcc_plugin.md](README.gcc_plugin.md).

‎qemu_mode/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# High-performance binary-only instrumentation for afl-fuzz
22

3-
For the general instruction manual, see [README.md](../README.md).
3+
For the general instruction manual, see [docs/README.md](../docs/README.md).
44

55
## 1) Introduction
66

‎testcases/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AFL++ starting test cases
22

3-
(See [../README.md](../README.md) for the general instruction manual.)
3+
For the general instruction manual, see [docs/README.md](../docs/README.md).
44

55
The archives/, images/, multimedia/, and others/ subdirectories contain small,
66
standalone files that can be used to seed afl-fuzz when testing parsers for a

‎utils/libdislocator/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# libdislocator, an abusive allocator
22

3-
(See ../../README.md for the general instruction manual.)
3+
For the general instruction manual, see [docs/README.md](../../docs/README.md).
44

55
This is a companion library that can be used as a drop-in replacement for the
66
libc allocator in the fuzzed binaries. It improves the odds of bumping into

‎utils/libtokencap/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The afl-clang-fast AFL_LLVM_DICT2FILE feature is much better, afl-clang-lto
66
has that feature automatically integrated.
77

8-
(See ../../README.md for the general instruction manual.)
8+
For the general instruction manual, see [docs/README.md](../../docs/README.md).
99

1010
This companion library allows you to instrument `strcmp()`, `memcmp()`,
1111
and related functions to automatically extract syntax tokens passed to any of

0 commit comments

Comments
 (0)