summaryrefslogtreecommitdiff
path: root/pages/docs/client/en.md
blob: ebf412e95a51c8b462a6399b984b4d27ea718361 (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
@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 [[the
LEAP Platform => platform]].  It is written in
[Python](https://www.python.org/) using [PySide](https://wiki.qt.io/PySide) and
licensed under the
[GPL3](https://github.com/leapcode/bitmask_client/blob/develop/LICENSE).
Currently we distribute pre-compiled bundles for Linux and OS X, with a Windows
bundle following soon.

For more info and a users guide goto [[bitmask.net => https://bitmask.net]].

Testers and Hackers see below.

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 16.04 (LTS)
* Mac OSX >= 10.8
* Note: It *should* work in other Debian based distros

### Using the debian package

* Ubuntu 17.04 (Zesty Zapus)
* Debian 9.0 (Stretch)
* Debian testing (Buster)