summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Weiser <michael.weiser@gmx.de>2019-02-11 10:40:05 +0000
committerMichael Weiser <michael.weiser@gmx.de>2019-02-11 13:04:20 +0000
commit94aa3eb4767d85df1c95fa410383818ce83075ef (patch)
treef10484fafbe77500b847fee922e5a74b760a3a41 /README.md
parentc4b980c73f7c4adfc1d9993f781b72c6829aa42f (diff)
Update installation documentation
Document that virtual environments are now the preferred installation option and how that works. Closes #55.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index d7cfded..6a4d6f1 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,8 @@ Install PeekabooAV
/path/to/venv/bin/pip install .
```
+This will pull in all required packages and install them into the virtualenv.
+
### Configuration ###
Take a look at ``peekaboo.conf.sample`` and ``ruleset.conf.sample``.
@@ -74,7 +76,7 @@ peekaboo --help
### Usage without Installation ###
-You can now run PeekabooAV without installing it using the ``peekaboo_debug.py`` script.
+You can also run PeekabooAV without installing it using the ``peekaboo_debug.py`` script.
```shell
python peekaboo_debug.py -c /path/to/your/peekaboo.conf
```