From 890b0ea0e21c649d704ad4306fb3decbdd7bc195 Mon Sep 17 00:00:00 2001 From: Leandro Doctors Date: Wed, 8 Feb 2017 12:27:47 -0300 Subject: [PATCH 1/5] README.md: "Compiling" <- "Building" --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e9931ca..7486793 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,9 @@ to Kinesis Advantage/Professional hardware.) * USB API for configuring, remapping and uploading programs to the keyboard. (C++ GUI client and Ruby library included.) -## Building +## Compiling -To build for a non-USB-capable AVR using the V-USB library: +To compile the project for a non-USB-capable AVR using the V-USB library: ````make -f Makefile.vusb HARDWARE_VARIANT=```` @@ -43,7 +43,7 @@ Currently supported hardware variants for non-USB AVRs are: * ````KINESIS```` (Kinesis Advantage/Professional, ATMega32, board design in schematic/Kinesis{Advantage/Professional}) * ````KINESIS110```` (Kinesis Model 110, ATMega32, board design in schematic/KinesisModel110) -To build for a USB-capable AVR using the LUFA library: +To compile the project for a USB-capable AVR using the LUFA library: ````make -f Makefile.lufa HARDWARE_VARIANT= HAS_EXTERNAL_STORAGE={1,0}```` From c56e2d7305930429357265df35387a3d3978db13 Mon Sep 17 00:00:00 2001 From: Leandro Doctors Date: Wed, 8 Feb 2017 13:28:19 -0300 Subject: [PATCH 2/5] README.md: Overhaul "Features" --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7486793..a2f518f 100644 --- a/README.md +++ b/README.md @@ -17,20 +17,17 @@ to Kinesis Advantage/Professional hardware.) ## Features - * Dynamically reprogrammable keyboard layout, including 'keypad layer' - support (two independent key layouts toggled by a 'keypad' key). + * Dynamically reprogrammable two-layer layout (one for the main keyboard, and one for the keypad), with layer switching via a 'keypad' key + * Also appears as USB mouse (whose functions can be bound to keys) * Onboard layout profiles to save/restore up to ten separate programmed keyboard layouts. - * Enhanced text macros that fully support modifier keys and can be triggered by - any combination of up to four keys. - * Programming, macro recording and layout backup save/load can be performed entirely - on-keyboard with no additional software. - * Also appears as USB mouse, mouse functions can be be bound to keys. - * Built-in virtual machine interpreter for running up to six concurrent - independent tasks. * Buzzer audio support (included in Kinesis hardware) - * USB API for configuring, remapping and uploading programs to the - keyboard. (C++ GUI client and Ruby library included.) + * USB API for configuring, remapping and uploading programs to the keyboard. (C++ Qt4-based GUI client and Ruby library included.) + * Enhanced text macros that fully support modifier keys and can be triggered by any combination of up to four keys [*](#myfootnote1) + * Programming, macro recording and layout backup save/load can be performed entirely on-keyboard with no additional software [*](#myfootnote1) + * Built-in virtual machine interpreter for running up to six concurrent independent tasks [*](#myfootnote1) + +*: This feature requires an external AT24C164 or compatible EEPROM (already built into Kinesis Advantage and Kinesis Advantage Pro keyboards). ## Compiling From 45a552c62611d7eed9fd6a2965ce9aee5af66e9c Mon Sep 17 00:00:00 2001 From: Leandro Doctors Date: Wed, 8 Feb 2017 13:32:25 -0300 Subject: [PATCH 3/5] README.md: Avoid old 80-columns wrap --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index a2f518f..6cedf60 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # Programmable keyboard firmware **(c) 2012-2014 Chris Andreae** -An extensively programmable USB keyboard firmware for AVR microcontrollers, -easily adaptable to new keyboard hardware. +An extensively programmable USB keyboard firmware for AVR microcontrollers, easily adaptable to new keyboard hardware. ## Hardware currently supported From 52fd57a30581e1b0c4b353cf2b45ea6496674e0c Mon Sep 17 00:00:00 2001 From: Leandro Doctors Date: Wed, 8 Feb 2017 13:34:15 -0300 Subject: [PATCH 4/5] README.md: "Currently supported Keyboards" <- "Hardware currently supported" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cedf60..2e8bf90 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ An extensively programmable USB keyboard firmware for AVR microcontrollers, easily adaptable to new keyboard hardware. -## Hardware currently supported +## Currently supported Keyboards * Kinesis Contoured (Advantage, Professional, Model 110) with drop-in microcontroller replacement (see schematic/ directory) From d67e37cb77892ba21ead879fc7bb72be07800539 Mon Sep 17 00:00:00 2001 From: Leandro Doctors Date: Wed, 8 Feb 2017 14:02:15 -0300 Subject: [PATCH 5/5] Overhaul "Currently supported keyboards" --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2e8bf90..b105c12 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,6 @@ An extensively programmable USB keyboard firmware for AVR microcontrollers, easily adaptable to new keyboard hardware. -## Currently supported Keyboards - - * Kinesis Contoured (Advantage, Professional, Model 110) with drop-in - microcontroller replacement (see schematic/ directory) - * Ergodox (on native Teensy hardware) - -Can support most ATMega series AVR microcontrollers, using LUFA if native USB is -available and VUSB otherwise. The macro and program-interpreter features require -an external AT24C164 or compatible I2C EEPROM. (This EEPROM is already built in -to Kinesis Advantage/Professional hardware.) - ## Features * Dynamically reprogrammable two-layer layout (one for the main keyboard, and one for the keypad), with layer switching via a 'keypad' key @@ -28,6 +17,20 @@ to Kinesis Advantage/Professional hardware.) *: This feature requires an external AT24C164 or compatible EEPROM (already built into Kinesis Advantage and Kinesis Advantage Pro keyboards). +## Currently Supported Keyboards + +For now, the firmware supports various keyboard models: + * Out of the box: + * Ergodox + * With drop-in microcontroller replacement (see schematic/ dir): + * various Kinesis contoured ergonomic keyboards + * Kinesis Contoured (tested on model 110; should also support models 100, 120 and 130) + * Kinesis Advantage & Kinesis Advantage Pro (models 500 and 510) + PR are welcome to extend support to other keyboards! + ++### Drop-in microcontroller replacement +The drop-in microcontroller replacement can be built using most ATMega series AVR microcontrollers. The firmware accesses it via either LUFA (if native USB is available) or VUSB. + ## Compiling To compile the project for a non-USB-capable AVR using the V-USB library: