From 77ce31c8ba1f90d8895ba16a2bb509db88071a10 Mon Sep 17 00:00:00 2001
From: llzmb <46303940+llzmb@users.noreply.github.com>
Date: Sat, 11 Dec 2021 19:13:22 +0100
Subject: Add docs content overview
---
docs/README.md | 41 ++++++++++++++++++++++
docs/afl-fuzz_approach.md | 2 +-
docs/resources/fuzzing_process_overview.drawio.svg | 4 +++
3 files changed, 46 insertions(+), 1 deletion(-)
create mode 100644 docs/README.md
create mode 100644 docs/resources/fuzzing_process_overview.drawio.svg
(limited to 'docs')
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..22f86de1
--- /dev/null
+++ 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.
+
+
+
+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)
\ No newline at end of file
diff --git a/docs/afl-fuzz_approach.md b/docs/afl-fuzz_approach.md
index 058fe352..6af39769 100644
--- 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
new file mode 100644
index 00000000..c46bfbbc
--- /dev/null
+++ b/docs/resources/fuzzing_process_overview.drawio.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
--
cgit v1.2.3
From 0993bcdc4e44a66b6d0b5e7ee234c834b00a5413 Mon Sep 17 00:00:00 2001
From: llzmb <46303940+llzmb@users.noreply.github.com>
Date: Sun, 12 Dec 2021 20:04:42 +0100
Subject: Delete image
---
docs/resources/fuzzing_process_overview.drawio.svg | 4 ----
1 file changed, 4 deletions(-)
delete mode 100644 docs/resources/fuzzing_process_overview.drawio.svg
(limited to 'docs')
diff --git a/docs/resources/fuzzing_process_overview.drawio.svg b/docs/resources/fuzzing_process_overview.drawio.svg
deleted file mode 100644
index c46bfbbc..00000000
--- a/docs/resources/fuzzing_process_overview.drawio.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
--
cgit v1.2.3
From 3a60f6a251210497f001673edefbe7a4e1627703 Mon Sep 17 00:00:00 2001
From: llzmb <46303940+llzmb@users.noreply.github.com>
Date: Mon, 13 Dec 2021 18:03:02 +0100
Subject: Add image references, update image
---
docs/README.md | 28 ++++++++++++++++++++--
.../0_fuzzing_process_overview.drawio.svg | 4 ++++
2 files changed, 30 insertions(+), 2 deletions(-)
create mode 100644 docs/resources/0_fuzzing_process_overview.drawio.svg
(limited to 'docs')
diff --git a/docs/README.md b/docs/README.md
index 22f86de1..2bd07bb6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -15,13 +15,37 @@ 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.
+image and select a step.
-
+
For further information on instrumentation, see the
[READMEs in the instrumentation/ folder](../instrumentation/).
+### Instrumenting the target
+
+For more information, click on the following image and select a step.
+
+
+
+### Preparing the fuzzing campaign
+
+For more information, click on the following image and select a step.
+
+
+
+### Fuzzing the target
+
+For more information, click on the following image and select a step.
+
+
+
+### Managing the fuzzing campaign
+
+For more information, click on the following image and select a step.
+
+
+
## Fuzzing other targets
To learn about fuzzing other targets, see:
diff --git a/docs/resources/0_fuzzing_process_overview.drawio.svg b/docs/resources/0_fuzzing_process_overview.drawio.svg
new file mode 100644
index 00000000..f7c5c7c8
--- /dev/null
+++ b/docs/resources/0_fuzzing_process_overview.drawio.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
--
cgit v1.2.3
From 9de3de6cdf4df87822cd77ce968380200fdddd26 Mon Sep 17 00:00:00 2001
From: llzmb <46303940+llzmb@users.noreply.github.com>
Date: Mon, 13 Dec 2021 21:14:20 +0100
Subject: Update images
---
docs/resources/0_fuzzing_process_overview.drawio.svg | 2 +-
docs/resources/1_instrument_target.drawio.svg | 6 +++++-
docs/resources/2_prepare_campaign.drawio.svg | 6 +++++-
docs/resources/3_fuzz_target.drawio.svg | 6 +++++-
docs/resources/4_manage_campaign.drawio.svg | 6 +++++-
5 files changed, 21 insertions(+), 5 deletions(-)
(limited to 'docs')
diff --git a/docs/resources/0_fuzzing_process_overview.drawio.svg b/docs/resources/0_fuzzing_process_overview.drawio.svg
index f7c5c7c8..0cccee6f 100644
--- a/docs/resources/0_fuzzing_process_overview.drawio.svg
+++ b/docs/resources/0_fuzzing_process_overview.drawio.svg
@@ -1,4 +1,4 @@
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/resources/1_instrument_target.drawio.svg b/docs/resources/1_instrument_target.drawio.svg
index 95afe77b..3b3502da 100644
--- a/docs/resources/1_instrument_target.drawio.svg
+++ b/docs/resources/1_instrument_target.drawio.svg
@@ -1,4 +1,8 @@
-
\ No newline at end of file
+<<<<<<< HEAD
+
+=======
+
+>>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
diff --git a/docs/resources/2_prepare_campaign.drawio.svg b/docs/resources/2_prepare_campaign.drawio.svg
index 44427908..5f2ef991 100644
--- a/docs/resources/2_prepare_campaign.drawio.svg
+++ b/docs/resources/2_prepare_campaign.drawio.svg
@@ -1,4 +1,8 @@
-
\ No newline at end of file
+<<<<<<< HEAD
+
+=======
+
+>>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
diff --git a/docs/resources/3_fuzz_target.drawio.svg b/docs/resources/3_fuzz_target.drawio.svg
index dbe34a87..9147b6e7 100644
--- a/docs/resources/3_fuzz_target.drawio.svg
+++ b/docs/resources/3_fuzz_target.drawio.svg
@@ -1,4 +1,8 @@
-
\ No newline at end of file
+<<<<<<< HEAD
+
+=======
+
+>>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
diff --git a/docs/resources/4_manage_campaign.drawio.svg b/docs/resources/4_manage_campaign.drawio.svg
index 3263b5bd..d066cd21 100644
--- a/docs/resources/4_manage_campaign.drawio.svg
+++ b/docs/resources/4_manage_campaign.drawio.svg
@@ -1,4 +1,8 @@
-
\ No newline at end of file
+<<<<<<< HEAD
+
+=======
+
+>>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
--
cgit v1.2.3
From 83487415b1ba3f11a6a03516b20923e6278cb97a Mon Sep 17 00:00:00 2001
From: llzmb <46303940+llzmb@users.noreply.github.com>
Date: Mon, 13 Dec 2021 21:22:33 +0100
Subject: Fix images
---
docs/resources/1_instrument_target.drawio.svg | 6 +-----
docs/resources/2_prepare_campaign.drawio.svg | 6 +-----
docs/resources/3_fuzz_target.drawio.svg | 6 +-----
docs/resources/4_manage_campaign.drawio.svg | 6 +-----
4 files changed, 4 insertions(+), 20 deletions(-)
(limited to 'docs')
diff --git a/docs/resources/1_instrument_target.drawio.svg b/docs/resources/1_instrument_target.drawio.svg
index 3b3502da..9e2d8734 100644
--- a/docs/resources/1_instrument_target.drawio.svg
+++ b/docs/resources/1_instrument_target.drawio.svg
@@ -1,8 +1,4 @@
-<<<<<<< HEAD
-
-=======
-
->>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
+
\ No newline at end of file
diff --git a/docs/resources/2_prepare_campaign.drawio.svg b/docs/resources/2_prepare_campaign.drawio.svg
index 5f2ef991..92cc61c0 100644
--- a/docs/resources/2_prepare_campaign.drawio.svg
+++ b/docs/resources/2_prepare_campaign.drawio.svg
@@ -1,8 +1,4 @@
-<<<<<<< HEAD
-
-=======
-
->>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
+
\ No newline at end of file
diff --git a/docs/resources/3_fuzz_target.drawio.svg b/docs/resources/3_fuzz_target.drawio.svg
index 9147b6e7..a4e5c940 100644
--- a/docs/resources/3_fuzz_target.drawio.svg
+++ b/docs/resources/3_fuzz_target.drawio.svg
@@ -1,8 +1,4 @@
-<<<<<<< HEAD
-
-=======
-
->>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
+
\ No newline at end of file
diff --git a/docs/resources/4_manage_campaign.drawio.svg b/docs/resources/4_manage_campaign.drawio.svg
index d066cd21..dae9fbf9 100644
--- a/docs/resources/4_manage_campaign.drawio.svg
+++ b/docs/resources/4_manage_campaign.drawio.svg
@@ -1,8 +1,4 @@
-<<<<<<< HEAD
-
-=======
-
->>>>>>> aceb1af908cd0d2b0b03cd23b917e59a18e7b0eb
+
\ No newline at end of file
--
cgit v1.2.3