Browse Source

move README to README.md and add a few words on the status of the project

Helmut Pozimski 7 years ago
parent
commit
574fe5370b
1 changed files with 9 additions and 14 deletions
  1. 9 14
      README.md

+ 9 - 14
README → README.md

@@ -1,5 +1,4 @@
-About
-=====
+# About
 
 jwmud is a simple daemon implemented in python that's intended to be used
 on low-power devices like the Raspberry Pi to turn them into an alarm clock.
@@ -11,36 +10,32 @@ leave periods) that differ from the generally defined times.
 To do the actual waking up, jwmud will call any command that is defined in the
 configuration file.
 
-Usage
-=====
+It is still a work in progress and not usable in any way.
+
+## Usage
 
 jwmud: TBD
 
 jwmuc: TBD
 
-Dependencies
-============
+## Dependencies
 
 The following software is required to run jwmud:
 
 * Python 3.0 or higher
 
-Copying
-=======
+## Copying
 
 Please refer to the license file.
 
-Configuration
-=============
+## Configuration
 
 TBD
 
-Known issues
-============
+## Known issues
 
 None yet, please contact me if you find any.
 
-Installation
-============
+## Installation
 
 TBD