README: formatting
authorMichael Gernoth <michael@gernoth.net>
Mon, 25 May 2015 15:58:38 +0000 (17:58 +0200)
committerMichael Gernoth <michael@gernoth.net>
Mon, 25 May 2015 15:58:38 +0000 (17:58 +0200)
README.md

index 26acc33..fd6cc03 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,42 +1,74 @@
-This repository contains utilities to use the [HM-CFG-USB(2)](http://www.elv.de/homematic-usb-konfigurations-adapter-1.html) (HomeMatic USB Konfigurations-Adapter) from [ELV](http://www.elv.de/) on Linux/Unix by using [libusb 1.0](http://www.libusb.org/).
+This repository contains utilities to use the [HM-CFG-USB(2)][] (HomeMatic USB
+Konfigurations-Adapter) from [ELV][] on Linux/Unix by using [libusb 1.0][].
 
-The HM-CFG-USB can be used to send and receive [BidCoS-Packets](http://homegear.eu/index.php/BidCoS%C2%AE_Packets) to control [HomeMatic](http://www.homematic.com/) home automation devices (like remote controllable sockets, switches, sensors, ...).
+The HM-CFG-USB can be used to send and receive [BidCoS-Packets][] to control
+[HomeMatic][] home automation devices (like remote controllable sockets,
+switches, sensors, ...).
 
-This repository contains, amongst others, an application, which emulates the HomeMatic LAN configuration adapter-protocol to make it possible to use the HM-CFG-USB in [Fhem](http://fhem.de/) or as a lan configuration tool for the CCU or the HomeMatic windows configuration software, also supporting devices using AES-signing like [KeyMatic](http://www.elv.de/homematic-funk-tuerschlossantrieb-keymatic-silber-inkl-funk-handsender.html).
+This repository contains, amongst others, an application, which emulates the
+HomeMatic LAN configuration adapter-protocol to make it possible to use the
+HM-CFG-USB in [Fhem][] or as a lan configuration tool for the CCU or the
+HomeMatic windows configuration software, also supporting devices using
+AES-signing like [KeyMatic][].
+
+[HM-CFG-USB(2)]: http://www.elv.de/homematic-usb-konfigurations-adapter-1.html
+[ELV]: http://www.elv.de/
+[libusb 1.0]: http://www.libusb.org/
+[BidCoS-Packets]: http://homegear.eu/index.php/BidCoS%C2%AE_Packets
+[HomeMatic]: http://www.homematic.com/
+[Fhem]: http://fhem.de/
+[KeyMatic]: http://www.elv.de/homematic-funk-tuerschlossantrieb-keymatic-silber-inkl-funk-handsender.html
 
 ### Short hmland HowTo: ###
 
-1.  Install prerequisites: `apt-get install libusb-1.0-0-dev build-essential git`
+1.  Install prerequisites:
+    `apt-get install libusb-1.0-0-dev build-essential git`
 2.  Get the current version of this software (choose **one** option):
     *   Get the current version via git (can be easily updated with `git pull`):
         1.  `git clone git://git.zerfleddert.de/hmcfgusb`
         2.  Change into the new directory: `cd hmcfgusb`
     *   Get the current version as an archive:
-        1.  [hmcfgusb-HEAD-xxxxxxx.tar.gz](https://git.zerfleddert.de/cgi-bin/gitweb.cgi/hmcfgusb/snapshot/HEAD.tar.gz) (xxxxxxx is part of the commit-id. xxxxxxx is just a placeholder for this HowTo, use your value)
+        1.  [hmcfgusb-HEAD-xxxxxxx.tar.gz][] (xxxxxxx is part of the commit-id.
+           xxxxxxx is just a placeholder for this HowTo, use your value)
         2.  Extract the archive: `tar xzf hmcfgusb-HEAD-xxxxxxx.tar.gz`
         3.  Change into the new directory: `cd hmcfgusb-HEAD-xxxxxxx`
 3.  Build the code: `make`
-4.  Optional: Install udev-rules so normal users can access the device: `sudo cp hmcfgusb.rules /etc/udev/rules.d/`
+4.  Optional: Install udev-rules so normal users can access the device:
+    `sudo cp hmcfgusb.rules /etc/udev/rules.d/`
 5.  Plug in the HM-CFG-USB
-6.  Run hmland (with debugging the first time, see `-h` switch): `./hmland -p 1234 -D`
+6.  Run hmland (with debugging the first time, see `-h` switch):
+    `./hmland -p 1234 -D`
 7.  Configure Fhem to use your new HMLAN device:  
     ``define hmusb HMLAN 127.0.0.1:1234``  
     ``attr hmusb hmId <hmId>``
 
+[hmcfgusb-HEAD-xxxxxxx.tar.gz]: https://git.zerfleddert.de/cgi-bin/gitweb.cgi/hmcfgusb/snapshot/HEAD.tar.gz
+
 ### Updating the HM-CFG-USB firmware to version 0.967: ###
 
-1.  Compile the hmcfgusb utilities like in the hmland HowTo above (steps 1 to 5) and stay in the directory
-2.  Download the new firmware: [hmusbif.03c7.enc](https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc): `wget https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc`
+1.  Compile the hmcfgusb utilities like in the hmland HowTo above
+    (steps 1 to 5) and stay in the directory
+2.  Download the new firmware: [hmusbif.03c7.enc][]:
+    `wget https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc`
 3.  Make sure that hmland is not running
-4.  Flash the update to the USB-stick: `./flash-hmcfgusb hmusbif.03c7.enc` (You might need to use `sudo` for this)
+4.  Flash the update to the USB-stick:
+    `./flash-hmcfgusb hmusbif.03c7.enc` (You might need to use `sudo` for this)
+
+[hmusbif.03c7.enc]: https://git.zerfleddert.de/hmcfgusb/firmware/hmusbif.03c7.enc
 
 ### Updating HomemMatic devices over the air (OTA): ###
 
-1.  Compile the hmcfgusb utilities like in the hmland HowTo above (steps 1 to 5) and stay in the directory
-2.  Download the new firmware from [eQ-3](http://www.eq-3.de/downloads.html), in this example the HM-CC-RT-DN firmware version 1.4
+1.  Compile the hmcfgusb utilities like in the hmland HowTo above
+    (steps 1 to 5) and stay in the directory
+2.  Download the new firmware from [eQ-3][], in this example the HM-CC-RT-DN
+    firmware version 1.4
 3.  Extract the tgz-file: `tar xvzf hm_cc_rt_dn_update_V1_4_001_141020.tgz`
 4.  Make sure that hmland is not running
-*   When using the **HM-CFG-USB**, flash the new firmware to the device with serial KEQ0123456:  
+*   When using the **HM-CFG-USB**, flash the new firmware to the device with
+    serial *KEQ0123456*:  
      `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456`
-*   When using a **culfw**-based device (**CUL/COC/...**), flash the new firmware to the device with serial KEQ0123456:  
+*   When using a **culfw**-based device (**CUL/COC/...**), flash the new
+    firmware to the device with serial *KEQ0123456*:  
      `./flash-ota -f hm_cc_rt_dn_update_V1_4_001_141020.eq3 -s KEQ0123456 -c /dev/ttyACM0`
+
+[eQ-3]: http://www.eq-3.de/downloads.html
Impressum, Datenschutz