From bb44e37623872e94e4d636154d45421f228a9eff Mon Sep 17 00:00:00 2001
From: lesander <4174509+lesander@users.noreply.github.com>
Date: Fri, 8 Nov 2024 11:47:56 +0100
Subject: [PATCH] update readme to reflect changes

---
 README.md | 48 +++++++++++++++---------------------------------
 1 file changed, 15 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 1463c2bde9..78eb7c4910 100644
--- a/README.md
+++ b/README.md
@@ -18,62 +18,44 @@ the Volatility Software License (VSL). See the
 [LICENSE](https://www.volatilityfoundation.org/license/vsl-v1.0) file for 
 more details.
 
-## Requirements
+## Installing
 
-Volatility 3 requires Python 3.8.0 or later. To install the most minimal set of dependencies (some plugins will not work) use a command such as:
+Volatility 3 requires Python 3.9.0 or later and is published on the [PyPi registry](https://pypi.org/project/volatility3).
 
 ```shell
-pip3 install -r requirements-minimal.txt
+pip install volatility3
 ```
 
-Alternately, the minimal packages will be installed automatically when Volatility 3 is installed using pip. However, as noted in the Quick Start section below, Volatility 3 does not *need* to be installed prior to using it.
+If you want to use the latest development version of Volatility 3 we recommend you manually clone this repository and install an editable version of the project.
+We recommend you use a virtual environment to keep installed dependencies separate from system packages.
 
-```shell
-pip3 install .
-```
-
-To enable the full range of Volatility 3 functionality, use a command like the one below. For partial functionality, comment out any unnecessary packages in [requirements.txt](requirements.txt) prior to running the command.
-
-```shell
-pip3 install -r requirements.txt
-```
-
-## Downloading Volatility
-
-The latest stable version of Volatility will always be the stable branch of the GitHub repository. You can get the latest version of the code using the following command:
+The latest stable version of Volatility will always be the `stable` branch of the GitHub repository. The default branch is `develop`.
 
 ```shell
 git clone https://github.com/volatilityfoundation/volatility3.git
+cd volatility3/
+python3 -m venv venv && . venv/bin/activate
+pip install -e .[dev]
 ```
 
 ## Quick Start
 
-1. Clone the latest version of Volatility from GitHub:
-
-    ```shell
-    git clone https://github.com/volatilityfoundation/volatility3.git
-    ```
+1. Install Volatility 3 as documented in the Installing section of the readme.
 
 2. See available options:
 
     ```shell
-    python3 vol.py -h
+    vol -h
     ```
 
-3. To get more information on a Windows memory sample and to make sure
-Volatility supports that sample type, run
-`python3 vol.py -f <imagepath> windows.info`
-
-   Example:
+3. To get more information on a Windows memory sample and to make sure Volatility supports that sample type, run `vol -f <imagepath> windows.info`:
 
     ```shell
-    python3 vol.py -f /home/user/samples/stuxnet.vmem windows.info
+    vol -f /home/user/samples/stuxnet.vmem windows.info
     ```
 
-4. Run some other plugins. The `-f` or `--single-location` is not strictly
-required, but most plugins expect a single sample. Some also
-require/accept other options.  Run `python3 vol.py <plugin> -h`
-for more information on a particular command.
+4. Run some other plugins. The `-f` or `--single-location` is not strictly required, but most plugins expect a single sample.
+Some also require/accept other options.  Run `vol <plugin> -h` for more information on a particular command.
 
 ## Symbol Tables