[tor-commits] [ooni-probe/master] Tweak README.md wording (#726)

art at torproject.org art at torproject.org
Fri Sep 22 18:41:06 UTC 2017


commit ede2bc6eec8839329003b1b5eb70d62b1d5ebc92
Author: Simone Basso <bassosimone at gmail.com>
Date:   Mon Jan 30 20:48:41 2017 +0100

    Tweak README.md wording (#726)
    
    * Tweak README.md wording
    
    * Use macOS and change brew link
    
    * wrap url in angular brackets
    
    * Clarify what happens when you run commands
    
    While there, also explain how to run ooniprobe-agent, which is part of
    what you want to know as a tester / developer.
    
    * Tweak previous
    
    * Tweak previous again
---
 README.rst | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index 3de9489b..d2ecac39 100644
--- a/README.rst
+++ b/README.rst
@@ -86,15 +86,15 @@ Note: You'll need to swap out ``$RELEASE`` for either ``yakkety``, ``xenial`` or
 ``trusty``. This will not happen automatically. You will also need to ensure
 that you have the ``universe`` repository enabled. The ``universe`` repository
 is enabled by default in a standard Ubuntu installation but may not be on some
-minimal on not standard installations.
+minimal, or not standard, installations.
 
 Installation
 ============
 
-Mac OS X
---------
+macOS
+-----
 
-You can install ooniprobe on OSX if you have installed homebrew (http://mxcl.github.io/homebrew) with::
+You can install ooniprobe on macOS if you have installed homebrew (http://brew.sh/) with::
 
     brew install ooniprobe
 
@@ -147,7 +147,7 @@ Configuring ooniprobe
 ---------------------
 
 After successfully installing ooniprobe you should be able to access the web UI
-on your host machine at http://localhost:8842/ .
+on your host machine at <http://localhost:8842/>.
 
 You should now be presented with the web UI setup wizard where you can read the
 risks involved with running ooniprobe. Upon answering the quiz correctly you can
@@ -247,8 +247,17 @@ to be activated::
     pip install -r requirements.txt
     pip install -r requirements-dev.txt
     python setup.py install
-    ooniprobe -s  # if all went well, lists available tests
 
+Then, you can check whether the installation went well with::
+
+    ooniprobe -s
+
+This will explain you the risks of running ooniprobe and make sure you have
+understood them, afterwards it shows you the available tests.
+
+To run the ooniprobe agent, instead, type::
+
+    ooniprobe-agent run
 
 Donate
 -------





More information about the tor-commits mailing list