summaryrefslogtreecommitdiff
path: root/docs/client/en.md
blob: 3bfe3f16ed05fe7b0885f14d728255a1f2473dd5 (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
@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.

You can find the complete up-to-date documentation [at the python package documentation
site.](http://pythonhosted.org/leap.bitmask "Bitmask documentation")

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