diff README @ 418:cd990c7dc746 2.0.post1

Version: Prepares for 2.0.post1 release. * Adds more documentation how to use getan.
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 03 May 2017 17:13:37 +0200
parents d6d9d319bd2e
children 8b1916aabe65
line wrap: on
line diff
--- a/README	Wed May 03 16:29:24 2017 +0200
+++ b/README	Wed May 03 17:13:37 2017 +0200
@@ -11,9 +11,27 @@
 and press enter to start the clock. See ``INTRODUCTION`` for more keyboard
 commands.
 
-The time log entries will be saved in an sqlite database.
+The time log entries will be saved in an sqlite database,
+by default getan will create ``~/.getan/time.db``.
 The ``scripts/`` will help to generate reports from them.
 
+Customization
+-------------
+
+Use ``~/.getan/getanrc`` or the system-wide ``/etc/getanrc``
+to customize keys and colors. See ``getan/config.py`` for
+the recognized options. Example::
+
+    [keybindings]
+    # changes the insert function to be activated by the `)` key
+    insert: )
+
+    [theme]
+    header: light green, dark green
+    body: light green, black
+
+
+
 Installation
 ============
 
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)