Browse Source

updated README and INSTALL

Helmut Pozimski 10 years ago
parent
commit
96a12c31d9
3 changed files with 31 additions and 4 deletions
  1. 5 0
      INSTALL
  2. 26 3
      README
  3. 0 1
      TODO

+ 5 - 0
INSTALL

@@ -0,0 +1,5 @@
+You can just run the main file "stdd" directly from this directory by calling
+it from the shell or with the python interpreter ("./stdd" or "python stdd").
+Furthermore, stov uses python distutils as default installation method. Just
+run "python setup.py install" to install it into your system. For further
+information an options run "python setup.py --help".

+ 26 - 3
README

@@ -24,12 +24,35 @@ see LICENSE
 
 === Configuration ===
 
-TBD
+       HW_ADDRESS:    hardware  address  for  your  display, a common value is
+       "0x70" use i2cdetect to find yours if it doesn't match
+
+       BLINK_COLON:   define if you want the middle colon to blink, 0 = off, 1
+       = on
+
+       BRIGHTNESS_HIGH:    value  used for "high" brightness, valid values are
+       0-15
+
+       BRIGHTNESS_LOW:     value used for "low" brightness, valid  values  are
+       0-15
+
+       SET_BRIGHTNESS_LOW: value  used  for "low" brightness, valid values are
+       0-15
+
+       SET_BRIGHTNESS_HIGH:     time of the day to change the brightness  from
+       low to high
+
+       SYSLOG_LEVEL:  maximum  syslog  level to log, stdd uses debug, info and
+       error
+
+       SYSLOG_FACILITY:    syslog facility to use for logging (default:  user,
+       can also be daemon)
+
 
 === Known issues ===
 
 None yet
 
-=== Installation ===
+=== Installation ==
 
-TBD
+see INSTALL

+ 0 - 1
TODO

@@ -1,3 +1,2 @@
 * Add debian packaging
 ** Create a unprivileged user to run the daemon under
-* Add a man page