summaryrefslogtreecommitdiff
path: root/docs/client/en.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/client/en.md')
-rw-r--r--docs/client/en.md36
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)