about summary refs log tree commit diff
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2020-05-30 07:22:51 +0200
committervan Hauser <vh@thc.org>2020-05-30 07:22:51 +0200
commit0c50945303e12cbe46cfb98578bbe129305018c4 (patch)
tree6ef410fef9fcafe9e14187e368ccfc427ce15ccd
parent8726d7b0a351fcb16587acd80a4b42b521264692 (diff)
downloadafl++-0c50945303e12cbe46cfb98578bbe129305018c4.tar.gz
update readme
-rw-r--r--README.md17
1 files changed, 5 insertions, 12 deletions
diff --git a/README.md b/README.md
index 5ebd6b6b..68c387eb 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@
 
   * LLVM mode Ngram coverage by Adrian Herrera [https://github.com/adrianherrera/afl-ngram-pass](https://github.com/adrianherrera/afl-ngram-pass)
 
-  A more thorough list is available in the PATCHES file.
+  A more thorough list is available in the [PATCHES](docs/PATCHES.md) file.
 
   | Feature/Instrumentation | afl-gcc | llvm_mode | gcc_plugin | qemu_mode        | unicorn_mode |
   | ----------------------- |:-------:|:---------:|:----------:|:----------------:|:------------:|
@@ -134,6 +134,8 @@ For everyone who wants to contribute (and send pull requests) please read
 ## Building and installing afl++
 
 An easy way to install afl++ with everything compiled is available via docker:
+You can use the [Dockerfile](Dockerfile) (which has gcc-10 and clang-11 -
+hence afl-clang-lto is available!) or just pull directly from the docker hub:
 ```shell
 docker pull aflplusplus/aflplusplus
 docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus
@@ -149,6 +151,8 @@ sudo apt install build-essential libtool-bin python3-dev automake flex bison lib
 make distrib
 sudo make install
 ```
+It is recommended to install the newest available gcc and clang and llvm-dev
+possible in your distribution!
 
 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
@@ -193,17 +197,6 @@ These build options exist:
 
 e.g.: make ASAN_BUILD=1
 
-
-Note that afl++ is faster and better the newer the compilers used are.
-Hence at least gcc-9 and especially llvm-9 should be the compilers of choice.
-If your distribution does not have them, you can use the Dockerfile:
-
-```shell
-cd AFLplusplus
-sudo docker build -t aflplusplus .
-```
-
-
 ## Challenges of guided fuzzing
 
 Fuzzing is one of the most powerful and proven strategies for identifying