aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2019-09-16 14:49:05 +0200
committervan Hauser <vh@thc.org>2019-09-16 14:49:05 +0200
commitcaba176c874b0dcab3cc3f905613b85484948580 (patch)
treeb2e41ce7f59b17467e49fda8488b8a13c19b834d /README.md
parentf37e7c52401807857ce711dbf8340adbc6cebdd0 (diff)
downloadAFLplusplus-caba176c874b0dcab3cc3f905613b85484948580.tar.gz
more help in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index c697da4f..6fa95c95 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,30 @@
read this file.
+## 0) Building and installing afl++
+
+afl++ has many build options.
+The easiest is to build and install everything:
+
+```shell
+$ make distrib
+$ sudo make install
+```
+
+Note that "make distrib" also builds llvm_mode, qemu_mode, unicorn_mode and
+more. If you just want plain afl then do "make all", however compiling and
+using at least llvm_mode is highly recommended for much better results!
+
+These build options exist:
+
+* all: just afl
+* binary-only: everything for binary-only fuzzing: qemu_mode, unicorn_mode, libdislocator, libtokencap
+* source-only: everything for source code fuzzing: llvm_mode, libdislocator, libtokencap
+* distrib: everything (for both binary-only and source code fuzzing)
+* install: installs everything you have compiled with the build option above
+* clean: cleans everything. for qemu_mode and unicorn_mode it means it deletes all downloads as well
+
+
## 1) Challenges of guided fuzzing
Fuzzing is one of the most powerful and proven strategies for identifying