diff options
author | Kali Kaneko <kali@futeisha.org> | 2013-09-25 12:28:21 -0400 |
---|---|---|
committer | Kali Kaneko <kali@futeisha.org> | 2013-09-25 12:28:21 -0400 |
commit | 652879ef39b5a94fba50f8c78524e71e040e8b5b (patch) | |
tree | 8492d6cd4c1576d849d6496874b62b33d41a733f /docs/client/en.md | |
parent | 19f0917b007e83ade0a4de290d194964f027a35b (diff) |
update client docs
This are the most important pages in the bitmask documentation.
I have converted .rst files using pandoc, since the .rst
does not seem to be supported like the README says.
I have added @nav_title and @title headers.
Diffstat (limited to 'docs/client/en.md')
-rw-r--r-- | docs/client/en.md | 36 |
1 files changed, 32 insertions, 4 deletions
diff --git a/docs/client/en.md b/docs/client/en.md index accd7ad..3bfe3f1 100644 --- a/docs/client/en.md +++ b/docs/client/en.md @@ -1,12 +1,40 @@ +@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 [the LEAP Platform](platform). It is written in python using PySide and licensed under the GPL3. Currently we distribute pre-compiled bundles for Linux and OSX, with Windows bundles following soon. +Bitmask +======= -You can find the complete up-to-date documentation [at the python package documentation site.](http://pythonhosted.org/leap.bitmask "Bitmask documentation") +**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) -* [Bitmask Documentation index](client/client-index) -* [User guide](client/user-guide) <!-- * [Running latest code](client/bleeding-edge) |