From b0e58baca2e5f67ce7304545e656868005ff73bd Mon Sep 17 00:00:00 2001 From: Ruben ten Hove Date: Sat, 18 Jun 2022 08:21:25 -0400 Subject: add stable tag to docs --- README.md | 8 ++++---- docs/INSTALL.md | 4 ++-- docs/fuzzing_in_depth.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c3a627ec..d8498520 100644 --- a/README.md +++ b/README.md @@ -50,14 +50,14 @@ Here is some information to get you started: ## Building and installing AFL++ To have AFL++ easily available with everything compiled, pull the image directly -from the Docker Hub (available for x86_64 and arm64): +from the Docker Hub (available for both x86_64 and arm64): ```shell -docker pull aflplusplus/aflplusplus -docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus +docker pull aflplusplus/aflplusplus:stable +docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus:stable ``` -This image is automatically generated when a push to the stable repo happens +This image is automatically published when a push to the stable branch happens (see [branches](#branches)). If you use the command above, you will find your target source code in `/src` in the container. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 754621b5..ac7b5486 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -8,8 +8,8 @@ hence afl-clang-lto is available) or just pull directly from the Docker Hub (for x86_64 and arm64): ```shell -docker pull aflplusplus/aflplusplus -docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus +docker pull aflplusplus/aflplusplus:stable +docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus:stable ``` This image is automatically generated when a push to the stable repo happens. diff --git a/docs/fuzzing_in_depth.md b/docs/fuzzing_in_depth.md index 2c27dfe1..d5fae0a6 100644 --- a/docs/fuzzing_in_depth.md +++ b/docs/fuzzing_in_depth.md @@ -47,7 +47,7 @@ tasks, fuzzing may put a strain on your hardware and on the OS. In particular: example, the following line will run a Docker container with all this preset: ```shell - # docker run -ti --mount type=tmpfs,destination=/ramdisk -e AFL_TMPDIR=/ramdisk aflplusplus/aflplusplus + # docker run -ti --mount type=tmpfs,destination=/ramdisk -e AFL_TMPDIR=/ramdisk aflplusplus/aflplusplus:stable ``` ## 1. Instrumenting the target -- cgit 1.4.1