summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorkali <kali@leap.se>2012-12-19 07:45:02 +0900
committerkali <kali@leap.se>2012-12-19 07:45:02 +0900
commit5c0eb246d468454de9e84dca0d08c813459a5a6d (patch)
treece9dc227600aeaa7b2a11035926ed2ff15560efd /docs/index.rst
parent20f779b644a551bf56cb735868c55cd50d7c3610 (diff)
documentation update!
reSTructured (no pun intended) the sphinx docs, and trimmed README
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..5ccc6609
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,86 @@
+.. LEAP documentation master file, created by
+ sphinx-quickstart on Sun Jul 22 18:32:05 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+LEAP Encryption Access Project Client
+=====================================
+
+Release v\ |version|. (`Impatient? jump to the` :ref:`Installation <install>` `section!`)
+
+The **LEAP Client** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon.
+
+User Guide
+----------
+
+.. toctree::
+ :maxdepth: 2
+
+ user/intro
+ user/install
+ user/running
+
+Tester Guide
+------------
+
+This part of the documentation details how to fetch the last development version and how to report bugs.
+
+.. toctree::
+ :maxdepth: 1
+
+ testers/howto
+
+Hackers Guide
+---------------
+
+If you want to contribute to the project, we wrote this for you.
+
+.. toctree::
+ :maxdepth: 1
+
+ dev/environment
+ dev/tests
+ dev/resources
+ dev/internationalization
+
+.. dev/internals
+ dev/authors
+ dev/todo
+ dev/workflow
+
+Packager Guide
+---------------
+
+Docs related to the process of building and releasing a version of the client.
+
+.. toctree::
+ :maxdepth: 1
+
+ pkg/debian
+ pkg/osx
+ pkg/win
+
+
+Directories and Files
+---------------------
+
+Different directories and files used for the configuration of the client.
+
+.. toctree::
+ :maxdepth: 1
+
+ config/files
+
+
+API Documentation
+-----------------
+
+If you are looking for a reference to specific classes or functions, you are likely to find it here
+
+.. note::
+ when it's finished, that's it :)
+
+.. toctree::
+ :maxdepth: 2
+
+ api