X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=e16610c747971cdf8f88c39120d8f9eaa9cbaa15;hb=e6bb7df1d10e84a70de871f9d988ce7435a73939;hp=29b24e71fabe6f1ba0d8c4d96776a3508d1b7026;hpb=6f1d0df6565741b07a3c2eaeade2197e56769ce1;p=torbrowser-launcher.git

diff --git a/README.md b/README.md
index 29b24e7..e16610c 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,47 @@
-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:
-
-* Downloading the most recent version of TBB for you, in your language and for
-  your architecture
+# 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:
+
+* 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 isn't in any Debian repositories yet, but it will be soon.
+If you use Ubuntu, you can install it now from my PPA (see "Installing in Ubuntu" below). [Soon](https://github.com/micahflee/torbrowser-launcher/issues/31) it will be in Debian. To install it in any other distribution, follow the "Quick Start" instructions.
+
+You might want to check out the [security design doc](/security_design.md).
 
-Quick Start
------------
+## Quick Start
 
-If you're using a Debian-based distro like Debian, Ubuntu, or Linux Mint, the
-following instructions will install dependencies, clone this repo, build a .deb, and
-install it with dpkg.
+First, clone the repository:
 
-    sudo apt-get install python-stdeb python-gtk2 python-psutil python-twisted python-pygame python-lzma wmctrl gnupg fakeroot
     git clone https://github.com/micahflee/torbrowser-launcher.git
     cd torbrowser-launcher
-    ./build_and_install.sh
 
-Installing in Ubuntu
---------------------
+Then install dependencies, build a package, and install:
+
+### Debian, Ubuntu, Linux Mint, etc.
+
+    sudo apt-get install build-essential python-all python-stdeb python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot xz-utils
+    ./build_deb.sh
+    sudo dpkg -i deb_dist/torbrowser-launcher_*.deb
+
+Optionally you can install python-pygame if you want to play a modem sound while Tor Browser is launching.
+
+### Red Hat, Fedora, CentOS, etc.
+
+    sudo yum install python-psutil python-twisted wmctrl gnupg fakeroot
+    ./build_rpm.sh
+    sudo yum install dist/torbrowser-launcher-*.rpm
+
+Optionally you can install pygame if you want to play a modem sound while Tor Browser is launching.
+
+### Run without installing
+
+Install the dependencies: sadly, not all of them are available in virtualenv, so you will need to install (some of) them system-wide.
+Then, you can run: `TBL_SHARE=share ./torbrowser-launcher`
+
+## Installing in Ubuntu
 
 I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
 
@@ -33,8 +49,7 @@ I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can i
     sudo apt-get update
     sudo apt-get install torbrowser-launcher
 
-Enabling AppArmor Profiles
---------------------------
+## Enabling AppArmor Profiles
 
 AppArmor is a Linux kernel hardening technology that lets you confine specific programs to only use specific resources. For example, if you visit a website that exploits a bug in the Tor Browser to get arbitrary code execution, the attacker won't be able to access files in ~/.gnupg. Here's how you turn on the AppArmor profiles for Tor Browser Launcher and for the programs bundled in the TBB.
 
@@ -44,28 +59,3 @@ AppArmor is a Linux kernel hardening technology that lets you confine specific p
     sudo aa-enforce /etc/apparmor.d/torbrowser.Browser.firefox
     sudo aa-enforce /etc/apparmor.d/torbrowser.Tor.tor
 
-Building
-========
-
-Dependencies
-------------
-
-You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
-install it like this:
-
-    apt-get install python-stdeb
-
-Also install the ```torbrowser-launcher``` dependencies:
-
-    apt-get install python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot
-
-Debian packages
----------------
-
-To build a Debian source and binary packages:
-
-    python setup.py --command-packages=stdeb.command sdist_dsc 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