From d9f04f333fb9b10d1df6b590fbd065d289ab7c44 Mon Sep 17 00:00:00 2001 From: Jason Hiser <jdhiser@gmail.com> Date: Tue, 1 Jun 2021 12:22:38 +0000 Subject: [PATCH] Docker instructions. o Update to clarify when to use docker vs. source installation. o Give pointer to docker setup instructions --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c66e42e..7da1553 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,18 @@ Key features of Zafl: * 100% AFL compatible * Platform for experimenting with other instrumentation to guide afl, e.g., add calling context to the edge-profile function (a la Angora) -## Installation +## Installation with Docker + +A Docker-based installation is recommended for those getting started with Zafl. +Please intending to develop new functionality or fix bugs in existing code should install from source (see next section). + +To install the docker-based installation, please see the [install and use directions for the Docker-based setup.](https://git.zephyr-software.com/opensrc/libzafl/-/wikis/home) + +## Installation from Source + +Installing from source is not recommended for first-time Zafl users. Please see the Docker-based setup instructions. +This method is recommended only for those intending to bug-fix or develop new features for Zafl. + The instructions that follow assume that: * you are using a recent version of Linux, e.g., Ubuntu 18.04 -- GitLab