From 472547061c04db335fd1f76b9026d0d8539b8fea Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Mon, 11 Oct 2021 11:20:48 +0100 Subject: [PATCH] Core: Fix up setup.py documentation --- README.md | 2 +- requirements.txt | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c51bd060c..75c3c1c23 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Volatility 3 requires Python 3.6.0 or later. To install the most minimal set of pip3 install -r requirements-minimal.txt ``` -Alternately, the minimal packages can be installed automatically when Volatility 3 is installed. However, as noted in the Quick Start section below, Volatility 3 does not *need* to be installed prior to using it. +Alternately, the minimal packages will be installed automatically when Volatility 3 is installed using setup.py. However, as noted in the Quick Start section below, Volatility 3 does not *need* to be installed via setup.py prior to using it. ```shell python3 setup.py build diff --git a/requirements.txt b/requirements.txt index f9ec9d3d1..290d9ca97 100644 --- a/requirements.txt +++ b/requirements.txt @@ -17,8 +17,9 @@ pycryptodome # This can improve error messages regarding improperly configured ISF files. jsonschema>=2.3.0 -# This is required for memory acquisition via leech. +# This is required for memory acquisition via leechcore/pcileech. leechcorepyc>=2.4.0 -# This is required for analyzing Linux samples acquired with AVML. -python-snappy==0.6.0 \ No newline at end of file +# This is required for analyzing Linux samples compressed using AVMLs native +# compression format. It is not required for AVML's standard LiME compression. +python-snappy==0.6.0