[tor-commits] [gettor/master] Update README.md

ilv at torproject.org ilv at torproject.org
Tue Sep 22 23:39:12 UTC 2015


commit 83ccda99d1cfbeaafcf796e7280b7c1f35a37d84
Author: ilv <ilv at users.noreply.github.com>
Date:   Tue Aug 5 17:00:54 2014 -0400

    Update README.md
    
    Added some format.
---
 README.md |   16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 260ce5e..f1eddb9 100644
--- a/README.md
+++ b/README.md
@@ -9,18 +9,22 @@ $ git clone https://github.com/ileiva/gettor.git
 
 * To upload bundles to Dropbox and create a links file:
 
-1) Install the Dropbox and GnuPG Python modules (just the first time).
+1) Install the Dropbox and GnuPG Python modules (just the first time):
+
 $ pip install dropbox gnupg
 
 2) Change account info in src/dropbox.py (app_key, app_secret, access_token)
 
 3) Specify the path of the PGP key that signed the packages (to include fingerprint).
 
-4) Run the script.
-$ cd src; python dropbox.py
+4) Run the script:
+
+$ cd providers/;rm *.links;cd ../src; python dropbox.py
 
 If everything works good, you should see a dropbox.links file inside the 'providers' directory. The script will take the files on upload_dir (default to 'upload/') which end up on .xz and .xz.asc respectively. To add more locales for testing do the following (example for german):
+
 $ cd upload; cp tor-browser-linux32-3.6.2_en-EN.tar.xz tor-browser-linux32-3.6.2_de-DE.tar.xz
+
 $ cd upload; cp tor-browser-linux32-3.6.2_en-EN.tar.xz.asc tor-browser-linux32-3.6.2_de-DE.tar.xz.asc
 
 A script for getting the latest bundles is pending.
@@ -28,13 +32,15 @@ A script for getting the latest bundles is pending.
 * To test if the core module is working:
 
 1) Use the dummy script provided:
+
 $ python core_demo.py
 
 * To test the smtp module (without mail server):
 
 1) Set request parameters on smtp/sample/sample-email.eml (by default, 'To: gettor+en at torproject.org' and 'linux' in the body of the message. 
 
-2) Run dummy script.
+2) Run dummy script:
+
 $ python smtp_demo.py < smtp/sample/sample-email.eml
 
 If mail server is configured, then uncomment lines 328-332, 337, 353-359, and comment lines 334-335, 338, 360 on gettor/smtp.py. Also, you should enable e-mail forwarding as specified on https://gitweb.torproject.org/gettor.git/blob/HEAD:/README
@@ -42,11 +48,13 @@ If mail server is configured, then uncomment lines 328-332, 337, 353-359, and co
 * To test the xmpp module
 
 1) Install the SleekXMPP module:
+
 $ pip install sleekxmpp
 
 2) Change user details on xmpp.cfg
 
 3) Run dummy script.
+
 $ python xmpp_demo.py
 
 4) To communicate with the bot using Pidgin click on Friends -> New instant message. There are still some issues with bot responses.





More information about the tor-commits mailing list