summaryrefslogtreecommitdiff
path: root/pages/docs/client/en.md
blob: b03c38721a5f88c917cff817d12af197943b9a48 (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
@nav_title = "Bitmask"
@title = 'Bitmask'
@summary = "The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail"

**Bitmask** is the multiplatform desktop client for the services offered by
[[the LEAP Platform => platform]]. For more information, see [[bitmask.net =>
https://bitmask.net]].

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
----------

For installation docs see the [Bitmask website](https://bitmask.net/en/install)


Testers Guide
-------------

If you want to help us test Bitmask and do some QA on the bundle take a look at:


* [[Bundle testing => bundle-testing]] and
* [Contributing](https://github.com/leapcode/bitmask_client/blob/develop/CONTRIBUTING.rst)

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

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

* [[Setting up a development environment => dev-environment]]
* [Contributing](https://github.com/leapcode/bitmask_client/blob/develop/CONTRIBUTING.rst)


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

We currently support:

### Using the standalone bundle

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

### Using the debian package

* Ubuntu 14.04 (Trusty Tahr)
* Ubuntu 15.04 (Vivid Vervet)
* Debian 7.0 (Wheezy)
* Debian 8.0 (Jessie)