From 90aa802b1b0aaf1ae2000bd73a8311e87f683580 Mon Sep 17 00:00:00 2001 From: Nathan Freitas Date: Wed, 21 Oct 2009 23:57:31 +0000 Subject: [PATCH] added CHANGELOG and INSTALL documentation; begrudgingly agreed to call Jake by his proper name, and not Jack svn:r20813 --- AUTHORS | 2 +- CHANGELOG | 6 ++++++ INSTALL | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG create mode 100644 INSTALL diff --git a/AUTHORS b/AUTHORS index cb292545..85d042c5 100644 --- a/AUTHORS +++ b/AUTHORS @@ -15,7 +15,7 @@ Android application and managed the porting of Tor to Android. Contributors: ------------- -Jack Appelbaum regular gave Nathan a +Jake Appelbaum regular gave Nathan a swift kick in the rear to get this done. He has also provided extensive guidance and review. diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 00000000..6f0da51c --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,6 @@ + +Changes in version 0.0.1-alpha - 2009-10-21 +- First code release +- Major Features: Tor binary application is fully operational, UI: Start/Stop Tor, View Message Log, View Settings (torrc) + + diff --git a/INSTALL b/INSTALL new file mode 100644 index 00000000..e0fccf26 --- /dev/null +++ b/INSTALL @@ -0,0 +1,34 @@ + +Orbot: Android Onion Routing Robot +*********************************************** +This is a freely licensed open-source application developed for the +Android platform, that acts as a front-end to the Tor binary application. +Orbot also provides an HTTP Proxy for connecting web browsers and other +HTTP client applications into the Tor SOCKS interface. + +*** PreReqs *** +You need the Android Developer SDK to compile and build the APK file: http://developer.android.com/ +The project files including in this distribution are meant to be used with Eclipse: http://eclipse.org/ + +*** How to use *** +Currently, Orbot will work with any application that supports using an HTTP or SOCKS Proxy. +Once you start Tor using Orbot, you can then point your application to HTTP port 8118 or SOCKS port 9050 +on localhost IP 127.0.0.1. + +You can also set the Android system-wide HTTP proxy using the Mobile Network APN: +Settings->Mobile networks->Access Point Names->(select your Carrier APN): + +Proxy: 127.0.0.1 +Port:8118 + +** A Few Notes ** + +To ensure you are connected to the Tor network, you should browse to https://check.torproject.org + +The first time you activate Orbot, it may take a while to connect to Tor. Check the message log to +ensure you are "100% Bootstrapped". + + +*********************************************** + +/* Copyright (c) 2009, Nathan Freitas, The Guardian Project - http://openideals.com/guardian */