]> git.lizzy.rs Git - torbrowser-launcher.git/blobdiff - README.md
Allow url_list
[torbrowser-launcher.git] / README.md
index 3664f30d4a30d25deec6554b10162f64d65c6a43..b293a04ad3ad4ea9191c219e35efa94069239920 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,55 +1,37 @@
-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-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).
 
-Building
-========
+![Tor Browser Launcher screenshot](/screenshot.png)
 
-Dependencies
-------------
+# Installing
 
-You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
-install it like this:
+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 Flatpak:
 
-    apt-get install python-stdeb
+## Installing in any Linux distro using Flatpak
 
-Also install the ```torbrowser-launcher``` dependencies:
+Install Flatpak using these [instructions](https://flatpak.org/setup/).
 
-    apt-get install python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot
+Then install `torbrowser-launcher` like this:
 
-Debian packages
----------------
+```
+flatpak install flathub com.github.micahflee.torbrowser-launcher -y
+```
 
-To build a Debian source package:
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
 
-    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
+```
+flatpak run com.github.micahflee.torbrowser-launcher
+```