Browse Source

reformat README to Markdown and move it to README.md

Helmut Pozimski 7 years ago
parent
commit
e86a1c2d7b
1 changed files with 17 additions and 17 deletions
  1. 17 17
      README.md

+ 17 - 17
README → README.md

@@ -1,4 +1,4 @@
-=== About ===
+# About
 
 stdd (short for "simple time display daemon") is a handy little daemon for
 the Raspberry PI device that can be used to display the current time on a
@@ -6,11 +6,11 @@ the Raspberry PI device that can be used to display the current time on a
 makes heavy use of the python libraries published by Adafruit to control
 the display via I2C.
 
-=== USAGE ===
+## USAGE
 
 see ./stdd 
 
-=== Dependencies ===
+## Dependencies
 
 stov depends on the following software to be installed:
 
@@ -18,41 +18,41 @@ stov depends on the following software to be installed:
 	* python-smbus
 	* python-pcrtl (optional)
 
-=== COPYING ===
+## COPYING
 
 see LICENSE
 
-=== Configuration ===
+## Configuration
 
-       HW_ADDRESS:    hardware  address  for  your  display, a common value is
+       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
+       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
+       brightness_high:    value  used for "high" brightness, valid values are
        0-15
 
-       BRIGHTNESS_LOW:     value used for "low" brightness, valid  values  are
+       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
+       set_brightness_low: time of the day to change the brightness  from
+       high to low
+       
+       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
+       syslog_level:  maximum  syslog  level to log, stdd uses debug, info and
        error
 
-       SYSLOG_FACILITY:    syslog facility to use for logging (default:  user,
+       syslog_facility:    syslog facility to use for logging (default:  user,
        can also be daemon)
 
 
-=== Known issues ===
+## Known issues
 
 None yet
 
-=== Installation ==
+## Installation
 
 see INSTALL