]> git.lizzy.rs Git - torbrowser-launcher.git/blob - README.md
rearranged readme and added a quick start section. fixes #26
[torbrowser-launcher.git] / README.md
1 Tor Browser Launcher
2 ====================
3 Tor Browser Launcher is intended to make the Tor Browser Bundle (TBB) easier to
4 maintain and use for GNU/Linux users. You install ```torbrowser-launcher``` from your
5 distribution's package manager and it handles everything else, including:
6
7 * Downloading the most recent version of TBB for you, in your language and for
8   your architecture
9 * Automatically updating (while preserving your bookmarks and preferences)
10 * Verifying the TBB's [GnuPG signature](http://www.gnupg.org/gph/en/manual/x135.html)
11 * Adding a "Tor Browser" application launcher to your desktop environment's menu
12
13 Tor Browser Launcher isn't in any Debian repositories yet, but it will be soon.
14
15 Quick Start
16 -----------
17
18 If you're using a Debian-based distro like Debian, Ubuntu, or Linux Mint, the
19 following instructions will install dependencies, clone this repo, build a .deb, and
20 install it with dpkg.
21
22     sudo apt-get install python-stdeb python-gtk2 python-psutil python-twisted wmctrl gnupg
23     git clone https://github.com/micahflee/torbrowser-launcher.git
24     cd torbrowser-launcher
25     ./build_and_install.sh
26
27 Building
28 ========
29
30 Dependencies
31 ------------
32
33 You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
34 install it like this:
35
36     apt-get install python-stdeb
37
38 Also install the ```torbrowser-launcher``` dependencies:
39
40     apt-get install python-gtk2 python-psutil python-twisted wmctrl gnupg
41
42 Debian packages
43 ---------------
44
45 To build a Debian source package:
46
47     python setup.py --command-packages=stdeb.command sdist_dsc
48
49 To build a Debian binary package:
50
51     python setup.py --command-packages=stdeb.command bdist_deb
52
53 Once you've made a ```.deb```, you can install by running this as root:
54
55     dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb