From d25647171fcaea39d28d60ed9b00c89555e8d9c8 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 22:17:45 +0200 Subject: Update readme * Read the docs * Fix path to gpl image until we switch repos --- README.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 7c415663..5d601578 100644 --- a/README.rst +++ b/README.rst @@ -6,6 +6,13 @@ The LEAP Encryption Access Project Client .. image:: https://pypip.in/v/leap.bitmask/badge.png :target: https://crate.io/packages/leap.bitmask +Read the Docs! +------------------ + +The latest documentation is available at `Read The Docs`_. + +.. _`RTD`: http://bitmask.rtfd.org + Dependencies ------------------ @@ -101,7 +108,7 @@ which the first time should automagically install all the needed dependencies in License ======= -.. image:: https://raw.github.com/leapcode/bitmask/develop/docs/user/gpl.png +.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png Bitmask is released under the terms of the `GNU GPL version 3`_ or later. -- cgit v1.2.3 From e497e3bd99020f26dcfae3e0fa815179284a8050 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:26:54 +0200 Subject: Fix README link to rtd --- README.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 5d601578..f8308566 100644 --- a/README.rst +++ b/README.rst @@ -1,17 +1,26 @@ -The LEAP Encryption Access Project Client -========================================= - +Bitmask +======= *your internet encryption toolkit* .. image:: https://pypip.in/v/leap.bitmask/badge.png :target: https://crate.io/packages/leap.bitmask +**Bitmask** is the multiplatform desktop client for the services offered by +`the LEAP 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. + +.. _`PySide`: http://qt-project.org/wiki/PySide +.. _`the LEAP Platform`: https://github.com/leapcode/leap_platform + + Read the Docs! ------------------ The latest documentation is available at `Read The Docs`_. -.. _`RTD`: http://bitmask.rtfd.org +.. _`Read The Docs`: http://bitmask.rtfd.org Dependencies ------------------ @@ -62,7 +71,7 @@ Hacking The Bitmask git repository is available at:: - git://leap.se/bitmask + git://leap.se/leap_client Some steps need to be run when setting a development environment for the first time. -- cgit v1.2.3