hard-problems: listed other projects similar to soledad
[leap_doc.git] / docs / client / en.md
1 @nav_title = "Bitmask"
2 @title = 'Bitmask'
3 @summary = "The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail"
4
5 Bitmask
6 =======
7
8 **Bitmask** is the multiplatform desktop client for the services offered by [the LEAP Platform](platform).
9
10 It is written in python using [PySide](http://qt-project.org/wiki/PySide) and licensed under the GPL3. Currently we distribute pre-compiled bundles for Linux and OSX, with Windows bundles following soon.
11
12 We include below some sections of the user guide and the development documentation so you can get started.
13
14 User Guide
15 ----------
16 * [Installing Bitmask](client/user-install)
17 * [Running Bitmask](client/user-running)
18
19 Tester Guide
20 ------------
21
22 This part of the documentation details how to fetch the last development version and how to report bugs.
23
24 * [Howto for testers](client/testers-howto)
25
26 Hackers Guide
27 -------------
28
29 If you want to contribute to the project, we wrote this for you.
30
31 * [Setting up a development environment](client/dev-environment)
32
33
34 <!--
35 * [Running latest code](client/bleeding-edge)
36 * [Getting started with development](client/dev-guide)
37 * [Configuration](client/configuration)
38 * [Client API](client/client-api) -->
39
40
41 Supported OSs
42 -------------
43
44 We currently support:
45
46 ### Through the bundle
47
48 * Debian 7
49 * Ubuntu 12.04 (LTS)
50 * Ubuntu 13.10 (latest)
51 * Mac OSX >= 10.8
52 * Note: It *should* work in other Debian based distros
53
54 ### Through the debian package
55
56 * Ubuntu 13.04 (Raring Ringtail)
57 * Ubuntu 13.10 (Saucy Salamander)
58 * Debian 7.0 (Wheezy)
59 * Debian 8.0 (Jessie)