summaryrefslogtreecommitdiff
path: root/docs/client/en.md
blob: 33b57eeec661dcf898b221501cbb6d8c7df29cba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@nav_title = "Bitmask"
@title = 'Bitmask'
@summary = "The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail"

Bitmask
=======

**Bitmask** is the multiplatform desktop client for the services offered by [the LEAP Platform](platform).

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.

We include below some sections of the user guide and the development documentation so you can get started.

User Guide
----------
* [Installing Bitmask](client/user-install)
* [Running Bitmask](client/user-running)

Tester Guide
------------

This part of the documentation details how to fetch the last development version and how to report bugs.

* [Howto for testers](client/testers-howto)

Hackers Guide
-------------

If you want to contribute to the project, we wrote this for you.

* [Setting up a development environment](client/dev-environment)


<!--
* [Running latest code](client/bleeding-edge)
* [Getting started with development](client/dev-guide)
* [Configuration](client/configuration)
* [Client API](client/client-api) -->


Supported OSs
-------------

We currently support:

### Through the bundle

* Debian 7
* Ubuntu 12.04 (LTS)
* Ubuntu 14.04 (LTS)
* Ubuntu 14.10 (latest)
* Mac OSX >= 10.8 (coming very soon)
* Note: It *should* work in other Debian based distros

### Through the debian package

* Ubuntu 14.04 (Trusty Tahr)
* Ubuntu 14.10 (Utopic Unicorn) coming very soon
* Debian 7.0 (Wheezy)
* Debian 8.0 (Jessie)