]> git.lizzy.rs Git - torbrowser-launcher.git/blob - README.md
readme formatting & adding ext for github
[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 When you first launch Tor Browser Launcher, it will download TBB from
14 https://www.torproject.org/ and extract it in ```~/.torproject```, and then execute
15 it. When you run it after that it will just execute TBB.
16
17 Building a Debian package
18 =========================
19
20 Dependencies
21 ------------
22
23 You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
24 install it like this:
25
26     apt-get install python-stdeb
27
28 Also install the ```torbrowser-launcher``` dependencies:
29
30     apt-get install python-gtk2 python-psutil python-twisted wmctrl gnupg
31
32 Building and Installing
33 -----------------------
34
35 If you're using a Debian-based distribution, you can build a ```.deb``` and install it
36 in one step by running:
37
38     ./build_and_install.sh
39
40 To build a Debian source package:
41
42     python setup.py --command-packages=stdeb.command sdist_dsc
43
44 To build a Debian binary package:
45
46     python setup.py --command-packages=stdeb.command bdist_deb
47
48 Once you've made a ```.deb```, you can install by running this as root:
49
50     dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb