[or-cvs] r19770: {projects} - Fix installation description so that it actually describes (projects/gettor)

[kaner at seul.org]

Author: kaner
Date: 2009-06-21 14:53:31 -0400 (Sun, 21 Jun 2009)
New Revision: 19770

Modified:
   projects/gettor/README
   projects/gettor/TODO
Log:
- Fix installation description so that it actually describes the way gettor needs to get installed on moria (and others)
- setup.py still broken


Modified: projects/gettor/README
===================================================================
--- projects/gettor/README	2009-06-21 18:28:51 UTC (rev 19769)
+++ projects/gettor/README	2009-06-21 18:53:31 UTC (rev 19770)
@@ -19,31 +19,39 @@
 value is also adaptable through the config file parameter 'message_size_limit'
 in case you need to.
 
-You will want to ensure that you have a properly configured set
-of mo files for each translation. Generate and install mo files as follows:
+SETUP
+-----
 
-   GetTor.py -r
+This setup descripton presumes that you have access to the latest gettor svn 
+trunk somewhere in your local file system.
 
-As an example, for the user 'gettor' we will setup GetTor.py like so:
+First, you will need to copy files over to your installation directory:
 
-Your .forward file should look like this:
+    gettor at moria:~/src/trunk/$ cp GetTor.py /home/gettor/bin
+    gettor at moria:~/src/trunk/$ cp -r gettor /home/gettor/bin
+    gettor at moria:~/src/trunk/$ cp -r i18n /home/gettor/bin
 
-    gettor at moria:~$ cat .forward
-    "|/home/gettor/bin/GetTor.py"
+Here is a list of all files you'll need in place:
 
-Configure your ~/.gettorrc file (see "Configuration", below).
 
-XXX: This is totally incorrect, please fix it!
-These are the python files we need to run GetTor.py:
 
-    gettor at moria:~/bin$ ls
-    dkim.py              gettor_log.py       gettor.py
-    gettor_blacklist.py  gettor_opt.py       gettor_requests.py
-    gettor_config.py     gettor_packages.py  gettor_responses.py
+This is somewhat cumbersome, but until setup.py is fixed, this is ok as a 
+temporary solution.
 
+After that, you will want to ensure that you have a properly configured set
+of mo files for each translation. Generate and install mo files as follows:
+
+    gettor at moria:~/bin$ ./GetTor.py -r
+
+You'll see something like this upon success:
+
+    2009-06-21 20:06:01,324 (6136) Installing translation files done.
+
+Next, configure your ~/.gettorrc file (see "Configuration", below).
+
 Once you have everything installed, you'll want to initialize the file store:
 
-    gettor at moria:~/newbin$ ./GetTor.py -f -p
+    gettor at moria:~/bin$ ./GetTor.py -f -p
 
 You should see an rsync and finally something like:
 
@@ -58,6 +66,11 @@
     gettor at moria:~/bin$ ./GetTor.py -i
     2009-01-05 17:34:53,911 (16646) Installing cron done.
 
+Finally, you need to setup email forwarding to the GetTor bot like so:
+
+    gettor at moria:~$ cat .forward
+    "|/home/gettor/bin/GetTor.py"
+
 Now GetTor.py is installed, prepared and ready to serve files. Send it email!
 
 TRANSLATION FILES

Modified: projects/gettor/TODO
===================================================================
--- projects/gettor/TODO	2009-06-21 18:28:51 UTC (rev 19769)
+++ projects/gettor/TODO	2009-06-21 18:53:31 UTC (rev 19770)
@@ -4,7 +4,7 @@
   (multi-part download, etc.).
 - Write spec for how locale requests shall be formatted and parsed
 - Implement test (-t switch) functionality
-- Installer (setup.py doesn't work properly)
+- Fix setup.py installer!
 - Split (at least) tiger bundle into several smaller archives to avoid ~20MB
 - Add more translations
     - Freeze messages for translation