Merge branch 'deskos-xp-develop' into develop

[torbrowser-launcher.git] / README.md

diff --git a/README.md b/README.md
index 6257f15ecc14deab9db44505502ad71de05bf5c2..9ca9f3aefd80e45fe368fdd0bfe61ccab54a5007 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,50 +1,25 @@
-Tor Browser Launcher
-====================
-Tor Browser Launcher is intended to make the Tor Browser Bundle (TBB) easier to
-maintain and use for GNU/Linux users. You install ```torbrowser-launcher``` from your
-distribution's package manager and it handles everything else, including:
+# Tor Browser Launcher
 
-* Downloading the most recent version of TBB for you, in your language and for
-  your architecture
-* Automatically updating (while preserving your bookmarks and preferences)
-* Verifying the TBB's [GnuPG signature](http://www.gnupg.org/gph/en/manual/x135.html)
-* Adding a "Tor Browser" application launcher to your desktop environment's menu
+Tor Browser Launcher is intended to make Tor Browser easier to install and use for GNU/Linux users. You install ```torbrowser-launcher``` from your distribution's package manager and it handles everything else:
 
-When you first launch Tor Browser Launcher, it will download TBB from
-https://www.torproject.org/ and extract it in ```~/.torproject```, and then execute
-it. When you run it after that it will just execute TBB.
+* Downloads and installs the most recent version of Tor Browser in your language and for your computer's architecture, or launches Tor Browser if it's already installed (Tor Browser will automatically update itself)
+* Verifies Tor Browser's [signature](https://www.torproject.org/docs/verifying-signatures.html.en) for you, to ensure the version you downloaded was cryptographically signed by Tor developers and was not tampered with
+* Adds "Tor Browser" and "Tor Browser Launcher Settings" application launcher to your desktop environment's menu
+* Includes AppArmor profiles to make a Tor Browser compromise not as bad
+* Optionally plays a modem sound when you open Tor Browser (because Tor is so slow)
 
-Building a Debian package
-=========================
+Tor Browser Launcher is included in Ubuntu, Debian, and Fedora. To install it in any other distribution, see the [build instructions](/BUILD.md).
 
-Dependencies
-------------
+You might want to check out the [security design doc](/security_design.md).
 
-You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
-install it like this:
+![Tor Browser Launcher screenshot](/screenshot.png)
 
-    apt-get install python-stdeb
+# Installing in Ubuntu
 
-Also install the ```torbrowser-launcher``` dependencies:
+If you want to always have the latest version of the `torbrowser-launcher` package before your distribution gets it, you can use my PPA:
 
-    apt-get install python-gtk2 python-psutil python-twisted wmctrl gnupg
-
-Building and Installing
------------------------
-
-If you're using a Debian-based distribution, you can build a ```.deb``` and install it
-in one step by running:
-
-    ./build_and_install.sh
-
-To build a Debian source package:
-
-    python setup.py --command-packages=stdeb.command sdist_dsc
-
-To build a Debian binary package:
-
-    python setup.py --command-packages=stdeb.command bdist_deb
-
-Once you've made a ```.deb```, you can install by running this as root:
-
-    dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb
+```sh
+sudo add-apt-repository ppa:micahflee/ppa
+sudo apt-get update
+sudo apt-get install torbrowser-launcher
+```