[or-cvs] r12763: Update TODO; add top level README (in torpedo/trunk: . docs)

[sjm217 at seul.org]

Author: sjm217
Date: 2007-12-11 15:58:57 -0500 (Tue, 11 Dec 2007)
New Revision: 12763

Added:
   torpedo/trunk/README
Modified:
   torpedo/trunk/docs/TODO
Log:
Update TODO; add top level README

Added: torpedo/trunk/README
===================================================================
--- torpedo/trunk/README	                        (rev 0)
+++ torpedo/trunk/README	2007-12-11 20:58:57 UTC (rev 12763)
@@ -0,0 +1,48 @@
+Tor USB project
+===============
+
+Steven J. Murdoch <http://www.cl.cam.ac.uk/users/sjm217/>
+
+Contents
+--------
+
+build-scripts: Code for building and customizing a Tor USB bundle
+  \___ README: Further documentation
+
+docs: Documentation for project
+  \___ TODO: Pending tasks and commentary
+  |___ ToaST-startup: Rough description of ToaST startup procedure
+  |___ build-instructions.txt: Notes on building Vidalia and other
+                               bundle components
+
+src: Source code
+  \___ processtest: Qt project for starting Firefox and detecting
+  |                 termination behaviour (see included README for
+  |                 build instructions)
+  |___ old: Previous work from Shishir Nagaraja
+
+Status
+------
+
+Using build-scripts/buildpackage.py it is possible to create a working USB Tor
+bundle. It's limitations include:
+ - It uses the PortableTor and FirefoxPortable binaries
+ - No extensions are yet installed
+ - The starting program doesn't have a pretty icon
+ - Polipo is not included, instead Firefox connects directly to Tor
+
+Further issues are discussed in docs/TODO.
+
+Usage
+-----
+
+Tor Browser.exe is a 7zip self extracting archive. To extract the bundle, run
+this and point it to the install location. It will create a folder called "Tor
+Browser". This may be the hard disk, but is more likely the currently mounted
+USB drive. The install process needs only be performed once.
+
+Once the bundle is extracted, open the newly created folder and click "Tor
+Browser.bat" (may appear as simply "Tor Browser"). This will start Vidalia. Once
+Tor has successfully opened a circuit, Firefox will automatically be opened.
+
+To exit, close Firefox. Vidalia will automatically clean up and exit.

Modified: torpedo/trunk/docs/TODO
===================================================================
--- torpedo/trunk/docs/TODO	2007-12-11 20:57:45 UTC (rev 12762)
+++ torpedo/trunk/docs/TODO	2007-12-11 20:58:57 UTC (rev 12763)
@@ -15,6 +15,7 @@
 ---------------------
 
 - Produce new branding so we don't infringe on the Mozilla trademarks
+
 - Get FirefoxPortable building
 
 - Eventually try to remove NSIS dependency for FirefoxPortable and
@@ -35,6 +36,8 @@
 - Tailor error messages so are more appropriate to Tor (e.g. point out
   dangers when submitting forms to non-HTTPS URLs)
 
+- Add bookmarks that will help people understand tor better
+
 General
 -------
 
@@ -57,6 +60,10 @@
 
 - Build Tor and PortableFirefox myself
 
+- What should the installer look like (should it have the Tor logo)?
+  We need to be clear in the documentation about the difference between
+  the installer and the actual bundle
+
 Questions to ask
 ----------------