]> git.lizzy.rs Git - torbrowser-launcher.git/blobdiff - README.md
Merge pull request #460 from intrigeri/AppArmor-silence-lsb_release-denial
[torbrowser-launcher.git] / README.md
index 0e48ca48b115b396c97065eef0c5283fa320df6f..421fde14b86d51f4e72f9c82b5393e9061ca19e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,60 +1,53 @@
-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
+_**Are you getting an error?** Sometimes updates in Tor Browser itself will break Tor Browser Launcher. There's a good chance that the problem you're experiencing has already been fixed in the [newest version](https://github.com/micahflee/torbrowser-launcher/releases). Try installing from Flatpak (instructions below), or [build from source](/BUILD.md)._
 
-Tor Browser Launcher isn't in any Debian repositories yet, but it will be soon.
+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:
 
-Quick Start
------------
+* 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)
 
-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.
+Tor Browser Launcher is included in Ubuntu, Debian, and Fedora. To install it in any other distribution, see the [build instructions](/BUILD.md).
 
-    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
+You might want to check out the [security design doc](/security_design.md).
 
-Installing in Ubuntu
---------------------
+![Tor Browser Launcher screenshot](/screenshot.png)
 
-I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
+# Installing
 
-    sudo add-apt-repository ppa:micahflee/ppa
-    sudo apt-get update
-    sudo apt-get install torbrowser-launcher
+You can install `torbrowser-launcher` from your operating system's package manager, but it might be out-of-date and have issues working. If you want to make sure you always have the latest version, use one of the methods below to install:
 
-Building
-========
+## Installing in any Linux distro using Flatpak
 
-Dependencies
-------------
+Install Flatpak using these [instructions](https://flatpak.org/setup/).
 
-You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
-install it like this:
+Then install `torbrowser-launcher` like this:
 
-    apt-get install python-stdeb
+```
+flatpak install flathub com.github.micahflee.torbrowser-launcher -y
+```
 
-Also install the ```torbrowser-launcher``` dependencies:
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
 
-    apt-get install python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot
+```
+flatpak run com.github.micahflee.torbrowser-launcher
+```
 
-Debian packages
----------------
+## Installing from the PPA
 
-To build a Debian source and binary packages:
+If you use Ubuntu or one of its derivatives:
 
-    python setup.py --command-packages=stdeb.command sdist_dsc bdist_deb
+```sh
+sudo add-apt-repository ppa:micahflee/ppa
+sudo apt update
+sudo apt install torbrowser-launcher
+```
 
-Once you've made a ```.deb```, you can install by running this as root:
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
 
-    dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb
+```
+torbrowser-launcher
+```
\ No newline at end of file