From a9a5c69cbcf17a799538ae6d5809adaa001aa080 Mon Sep 17 00:00:00 2001 From: proxhotdog Date: Tue, 26 Nov 2013 17:07:39 +0800 Subject: [PATCH] Added README.md --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b330479 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +Description +===== +* Keymapper - An Arduino-based hardware QWERTY keyboard layout remapper. +* Last updated: 26 November 2013 + +What you can do with it? +==== +1. You can design your own keyboard layout with real hardware support +2. You can cheat your friend with it or do some other evil things :P +3. Just think about it! + + +How to use this +==== +##Hardware support +* Arduino Leonardo with [Circuits@Home USB Host Shield 2.0](http://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled) +* Teensy 2.0 with [Circuits@Home USB Host Shield for Arduino Pro Mini](http://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini) + +##Hardware assemble +1. Stack the USB Host Shield on top of Arduino Leonardo, for Teensy, soldering work is required, you may refer to [this page](http://forum.colemak.com/viewtopic.php?id=1561) + +2. Import [USB Host Shield 2.0 library](https://github.com/felis/USB_Host_Shield_2.0) to Arduino IDE + +3. Connect the stack to your computer and upload the sketch + +4. Plug your USB keyboard to the USB Host shield + +5. Done! Happy keyboard hacking :) + +##Keyboard layout switching +* QWERTY is the default layout +* To change layout, press: + - CTRL+SHIFT+0: QWERTY (Default) + - CTRL+SHIFT+1: Tarmak1 + - CTRL+SHIFT+2: Tarmak2 + - CTRL+SHIFT+3: Tarmak3 + - CTRL+SHIFT+4: Tarmak4 + - CTRL+SHIFT+5: Colemak + - CTRL+SHIFT+6: Dvorak + - CTRL+SHIFT+7: Workman + + +Acknowledgement +=== +Thanks to original author: [darkytoothpaste](https://github.com/darkytoothpaste/keymapper) +