[tor-commits] [ooni-probe/master] Improve Readme and fix typo in test_settings

[art at torproject.org]

commit f2e717b8be93b3c292727ec7355b6ea2e15963ec
Author: Arturo <art at fuffa.org>
Date:   Fri Nov 20 13:49:49 2015 +0100

    Improve Readme and fix typo in test_settings
---
 README.rst                  |   25 +++++++++++++++++++------
 ooni/tests/test_settings.py |    2 +-
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/README.rst b/README.rst
index 2934c20..71a253e 100644
--- a/README.rst
+++ b/README.rst
@@ -40,7 +40,7 @@ aware of the fact that you are running ooniprobe. This means that if running
 network measurement tests is something considered to be illegal in your country
 then you could be spotted.
 
-Futhermore, ooniprobe takes no precautions to protect the install target machine
+Furthermore, ooniprobe takes no precautions to protect the install target machine
 from forensics analysis.  If the fact that you have installed or used ooni
 probe is a liability for you, please be aware of this risk.
 
@@ -53,13 +53,19 @@ On debian testing or unstable::
 
 If you are running debian stable you can get it from backports via::
 
-    sudo sh -c 'echo "deb http://http.debian.net/debian wheezy-backports main" >> /etc/apt/sources.list'
+    sudo sh -c 'echo "deb http://http.debian.net/debian jessie-backports main" >> /etc/apt/sources.list'
     sudo apt-get update && sudo apt-get install ooniprobe
 
 On unix systems::
 
     sudo pip install ooniprobe
 
+**BUG** Note: Twisted version needs to be >=12.2.0 and <=14.0.0
+unistall/downgrage Twisted::
+
+    sudo pip uninstall Twisted
+    sudo pip install 'Twisted>=12.2.0,<=14.0.0'
+
 To install it from the current master run::
 
     sudo pip install https://github.com/TheTorProject/ooni-probe/archive/master.zip
@@ -374,9 +380,16 @@ that is different from master) with::
 Setting up development environment
 ----------------------------------
 
-On debian based systems this can be done with::
+On Debian based systems a development environment can be setup as follows: (prerequisites include build essentials, python-dev, and tor; for tor see https://www.torproject.org/docs/debian.html.en)::
 
-    sudo apt-get install libgeoip-dev python-virtualenv virtualenvwrapper
-    mkvirtualenv ooniprobe
-    python setup.py install
+
+    sudo apt-get install python-pip python-virtualenv virtualenv virtualenvwrapper
+    sudo apt-get install libgeoip-dev libffi-dev libdumbnet-dev libssl-dev libpcap-dev
+    git clone https://github.com/TheTorProject/ooni-probe
+    cd ooni-probe
+    mkvirtualenv ooniprobe  # . ~/.virtualenvs/ooniprobe/bin/activate to access later
+    pip install -r requirements.txt
     pip install -r requirements-dev.txt
+    python setup.py install
+    ooniprobe -s  # if all went well, lists available tests
+
diff --git a/ooni/tests/test_settings.py b/ooni/tests/test_settings.py
index 1d36b83..dca4485 100644
--- a/ooni/tests/test_settings.py
+++ b/ooni/tests/test_settings.py
@@ -79,7 +79,7 @@ class TestSettings(ConfigTestCase):
     @defer.inlineCallbacks
     def test_check_tor_correct(self):
         """
-        This test has been disabled because there is a starge concatenation of
+        This test has been disabled because there is a strange concatenation of
         conditions that make it not possible to run it on travis.
         The tests need to be run as root on travis so that the ones that use
         scapy will work properly. When running tor as root, though, it will by