Readme

Readme.md

@@ -16,15 +16,17 @@ The idea is to enable enhanced USB functions to almost all 'standard' Arduino bo
 * No SAM/ARM support (Due, Zero etc)
 
 **Supported HID devices:**
-* Keyboard with Leds out (modifiers + 6 keys pressed at the same time)
-* Teensy Keyboard with different keyboard layouts (german, french and many more)
-* BootKeyboard protocol for Improved/Teensy Keyboard (works under BIOS)
+* Keyboard with Leds out (8 modifiers + 6 keys pressed at the same time, + 1 limited linux consumer key)
+* ~~Teensy Keyboard with different keyboard layouts (german, french and many more)~~ soon
 * NKRO Keyboard with Leds out (press up to 113 keys at the same time)
 * Mouse (5 buttons, move, wheel)
+* BootKeyboard/BootMouse BIOS protocol support
 * Absolute Mouse
 * Consumer/Media Keys (4 keys for music player, web browser and more)
 * System Key (for PC standby/shutdown)
 * Gamepad (32 buttons, 4 16bit axis, 2 8bit axis, 2 D-Pads)
+* RawHID
+* Each device is available as single or multi report device (except RawHID)
 
 See the [wiki](https://github.com/NicoHood/HID/wiki/Features) for more information about features etc.
 
@@ -34,13 +36,14 @@ Download
 
 You have 3 versions you can download:
 * The master includes all fixes to the current stable release. Download it by clicking download at the right.
+You might need to get the latest hourly build of the Arduino IDE to use the current master.
 Use the [online Wiki](https://github.com/NicoHood/HID/wiki) to get the newest documentation.
 * Download an offline version in [releases](https://github.com/NicoHood/HID/releases).
 It's a snapshot of the current stable release but might have missed some updates that the current master branch has included.
 This also includes an offline version of the wiki. Offline versions will be available after some time when the official release is out.
-* Select [branch 'dev'](https://github.com/NicoHood/HID/tree/dev) to test the bleeding edge of this software. It might not work at all or has a lot of debugging stuff in it.
-If the dev version gets near to a new release a note will be placed here, that you can test the new dev beta.
-Currently there is no beta available.
+* Select [branch 'dev'](https://github.com/NicoHood/HID/tree/dev) to test the bleeding edge of this software.
+It might not work at all or has a lot of debugging stuff in it. An hourly IDE build is highly suggested.
+If the dev version gets near to a new release a big banner will be placed at the top.
 
 
 Wiki
@@ -59,39 +62,26 @@ You can contact me on my wordpress blog in the contact section.
 www.nicohood.de
 
 
-TODO
-====
-
-Under Construction. This is a todo list for myself.
-
-```
-Keyboard Layout for different Languages
-Clean up USB Core code from fixed values. Use better understandable definitions
-Magic key fix for 32u4?
-
-Check Keyboard keycode function again
-Generalize HID key definitions via HIDTables for example?
-
-Test with Android phone (HL1)
-improve keywords.txt
-```
-
-
 Version History
 ===============
 ```
 2.4 Release (xx.xx.2015)
 * Added Arduino IDE 1.6.6 compatibility with Pluggable HID
-* Improved Pluggable HID (have its own modifed copy now)
-* Changed USB-Core into a simple library, only possible with Pluggable HID
+* Improved Pluggable HID (see Arduyuino changelog for my improvements)
+* Changed USB-Core into a simple library, only made possible with Pluggable HID
 * Removed HID presets in boards menu (like mouse + keyboard + consumer + system)
 * Added Teensy Keyboard
 * Added NKRO Keyboard
 * Added Led report for Keyboard
-* Added HID out report in general (RAW HID preparation)
+* Added 1 Linux consumer key for keyboard
+* Added BootKeyboard/Mouse support (BIOS compatibility)
+* Added RawHID
 * Added a few key definitions
+* Renew whole Keyboard API and its definitions via enum
 * Uses .alinkage custom IDE option
-* Added BootKeyboard support (BIOS compatibility)
+* Improved and updated examples
+* A lot of other minor and major fixes I missed to mention.
+
 
 2.3 Release (never released)
 * Updated Libraries