nicer

README

@@ -1,32 +1,48 @@
-ebusd
+ebusd - eBUS daemon
------
+-------------------
 
-ebusd provides a communication interface to the energy bus (ebus) which is used
+ebusd is a daemon for handling communication with eBUS devices connected to a
-in various heating systems. It offers the following features:
+2-wire bus system ("energy bus" used by numerous heating systems).
-
- * active: send and receive ebus commands
-           poll commands and collect received data
-           scan ebus to identify bus participants
-
- * passive: collect data of seen ebus commands
-
- * dump raw data into binary files
-
- * provides an ascii interface to read/write of ebus data/messages.
 
 
-Tools
+Features
------
+--------
 
- * 'ebusctl' is a tcp socket client for ebusd.
+The main features of the daemon are:
- * 'ebusfeed' is a tool to feed ebusd with raw data from dump files.
+
+ * actively send messages to and receive answers from the eBUS
+ * passively listen to messages sent on the eBUS
+ * regularly poll for messages
+ * scan for bus participants
+ * cache all data
+ * log messages and problems to a log file
+ * dump sent/received bytes to the log file
+ * dump received bytes to binary files for later playback/analysis
+ * listen for client connections on a dedicated TCP port
 
 
-Instructions for use and further information: https://github.com/john30/ebusd/wiki
+Installation
+------------
+
+Building ebusd from the source requires the following packages:
+ * autoconf (>=2.65)
+ * g++
+ * make
+
+To start the build process, run these commands:
+./autogen.sh
+make install
 
 
+Documentation
+-------------
 
+Usage instructions and further information can be found here:
+https://github.com/john30/ebusd/wiki
+
+
+Contact
+-------
 For bugs and missing features use github issue system.
 
-
 The author can be contacted at ebusd@johnm.de .