[tor-commits] [onionperf/master] Adds setuptools and alternative installation instructions

[karsten at torproject.org]

commit fb96513ad0fe66fbab60bb5eca6e1989131d039b
Author: Ana Custura <ana at netstat.org.uk>
Date:   Fri May 29 14:51:48 2020 +0100

    Adds setuptools and alternative installation instructions
---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e684991..a3905f4 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ For a dockerized setup, see https://github.com/hiromipaw/onionperf-docker
 These are the quick deployment instructions for the current Debian stable distribution.
 
 ```
-sudo apt install git cmake make build-essential gcc libigraph0-dev libglib2.0-dev python3-dev libxml2-dev python3-lxml python3-networkx python3-scipy python3-matplotlib python3-numpy libevent-dev libssl-dev python3-stem python3-pandas python3-seaborn tor
+sudo apt install git cmake make build-essential gcc libigraph0-dev libglib2.0-dev python3-dev libxml2-dev python3-lxml python3-networkx python3-scipy python3-matplotlib python3-numpy libevent-dev libssl-dev python3-stem python3-pandas python3-seaborn python3-setuptools tor
 
 git clone https://github.com/shadow/tgen.git
 cd tgen
@@ -88,7 +88,7 @@ sudo apt install cmake make build-essential gcc libigraph0-dev libglib2.0-dev py
 The easiest way to satisfy all system dependencies is to use a package manager.
 
 ```
-apt install tor libxml2-dev python3-lxml python3-networkx python3-scipy python3-matplotlib python3-numpy python3-stem python3-pandas python3-seaborn
+apt install tor libxml2-dev python3-lxml python3-networkx python3-scipy python3-matplotlib python3-numpy python3-stem python3-pandas python3-seaborn python3-setuptools
 
 ```
 
@@ -193,6 +193,16 @@ python3 setup.py build
 python3 setup.py install
 ```
 
+The installation step for Onionperf can be omitted, and instead Onionperf can run directly from the cloned repository:
+
+```
+git clone https://github.com/torproject/onionperf
+cd onionperf/onionperf
+PYTHONPATH=.. python3 onionperf
+```
+
+Dependencies (with the exception of ```python3-setuptools```) must be installed for Onionperf to run in this way.
+
 ## Run OnionPerf
 
 OnionPerf has several modes of operation and a help menu for each. For a