diff README @ 417:d6d9d319bd2e

Prepares for PyPi publication.
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 03 May 2017 16:29:24 +0200
parents 69ef6f89e930
children cd990c7dc746
line wrap: on
line diff
--- a/README	Wed May 03 14:06:35 2017 +0200
+++ b/README	Wed May 03 16:29:24 2017 +0200
@@ -1,3 +1,19 @@
+Usage
+=====
+
+Call ``getan`` or ``getan.py`` in a terminal to start
+with an empty list of tasks that you want to track time for.
+
+Use the Insert-Key to add a new task to track.
+(A *task* is called *project* within getan.)
+
+Now select one of the projects with the arrow keys from your keyboard
+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 ``scripts/`` will help to generate reports from them.
+
 Installation
 ============
 
@@ -125,4 +141,4 @@
 
     $ getan-classic /path/to/mytime.db
 
-# vim: set ts=4 sw=4 tw=80 filetype=rst :
+.. vim: set ts=4 sw=4 tw=80 filetype=rst :
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)