add quickstart-guide to docs and placeholders for config and cli

* bump version to 0.6.4

docs/source/cli.rst

@@ -0,0 +1,2 @@
+Command-Line-Interface
+**********************

docs/source/conf.py

@@ -56,7 +56,7 @@ author = 'Thor77'
 # The short X.Y version.
 version = '0.6'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.3'
+release = '0.6.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/config.rst

@@ -0,0 +1,2 @@
+Config
+******

docs/source/index.rst

@@ -1,10 +1,16 @@
 Welcome to TeamspeakStats's documentation!
 ==========================================
 
+This document contains a more in-depth and technical documentation (in contrast to the `README <https://github.com/Thor77/TeamspeakStats/blob/master/README.md>`_)
+for TeamspeakStats.
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   api
+   quickstart
+   cli
+   config
    identmap
+   api

docs/source/quickstart.rst

@@ -0,0 +1,30 @@
+Quickstart
+**********
+First, you have to get and install a decent version of `Python <https://python.org/>`_ (at least 2.7).
+Now you have various options to use TeamspeakStats, going from easy to hard:
+
+1. Install the tool via pip ``pip install tsstats``
+2. Clone the sourcecode ``git clone https://github.com/Thor77/TeamspeakStats``
+
+  * **A** Just run the script from your local copy ``python -m tsstats``
+  * **B** Install the script with the included *setup.py* ``python setup.py install``
+
+To start, you can just use cli-arguments to control the behaviour of TeamspeakStats::
+
+  usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d]
+
+  A simple Teamspeak stats-generator - based on server-logs
+
+  optional arguments:
+    -h, --help            show this help message and exit
+    -c CONFIG, --config CONFIG
+                          path to config
+    --idmap IDMAP         path to id_map
+    -l LOG, --log LOG     path to your logfile(s)
+    -o OUTPUT, --output OUTPUT
+                          path to the output-file
+    -d, --debug           debug mode
+
+Take a look at :doc:`cli` to get a more in-depth explanation of the available flags.
+If you want to use TeamspeakStats in a script (or cron) you should consider creating
+a :doc:`config`.

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='tsstats',
-    version='0.6.3',
+    version='0.6.4',
     author='Thor77',
     author_email='thor77@thor77.org',
     description='A simple Teamspeak stats-generator',