diff --git a/license.md b/license.md index 1a7307e..32f28cf 100644 --- a/license.md +++ b/license.md @@ -1,9 +1,13 @@ # The MIT License (MIT) -Taken from on 2012-03-10 +Retrieved from on 2012-03-10 + +This copyright and licence apply to all files in this project, except where +otherwise noted. If you feel that this infringes on any existing intellectual +property, please email me at the address below. ------------------------------------------------------------------------------- -Copyright © 2012 Ben Blazak +Copyright © 2012 Ben Blazak Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/readme.md b/readme.md index 730b885..9404d59 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,13 @@ -# [ergodox-firmware][]: Firmware for the [ergoDOX keyboard][] +# [ergodox-firmware][]: Firmware for the [ErgoDox keyboard][] + +Also see the [geekhack] +(http://geekhack.org/showthread.php?22780-Interest-Check-Custom-split-ergo-keyboard) +and [deskthority] +(http://deskthority.net/workshop-f7/split-ergonomic-keyboard-project-t1753.html) +discussion threads. [ergodox-firmware]: https://github.com/benblazak/ergodox-firmware -[ergodox keyboard]: http://geekhack.org/showthread.php?22780-Interest-Check-Custom-split-ergo-keyboard +[ergodox keyboard]: http://ergodox.org/ ## About this File @@ -40,38 +46,17 @@ started this project), but for now: matrix to hardware matrix mapping, and hardware specific documentation. * [src/main.c] (src/main.c) ties it all together. -Open issues and such are tracked [on github] +Open issues, feature requests, and such are tracked [on github] (/benblazak/ergodox-firmware/issues). ## Notes -### (2012-04-11) (first major release on branch 'main') -As of now, it looks like we have a working 6-KRO keyboard firmware for a Teensy -2.0 with a MCP23018 I/O expander. It's scanning at ~167 Hz, most of which is -spent communicating over I²C. This should be fast enough, I think. -Slight improvements might be possible (without finding a microprocessor capable -of > 400 kHz I²C or using SPI, that is, which I imagine would speed things -up a lot - but it'd also be much less convenient). I'll attempt them if I see -the need. - -Also, layers are implemented, but untested, as no keymaps are written to use -them yet. Implementing on-keyboard hardware remapping seems like it'd be very -possible too, but I'd need to try it (and learn how to programmatically store -stuff in program space) to see if it'd work; and I'm not sure of a good way to -do the interface, since different people will likely have different keycap -layouts on the ergoDOX. - -Getting to N-KRO is a goal, but I honestly have no idea whether it'll be -accomplished. Ideally, I'd like a variable-KRO, where the keyboard is 6-KRO -till you press the 7th key (so if you're worried about compatibility, just -don't press more than 6 keys at a time). From what I've read, it might be -possible, but I just finished everything else (so I'm slightly tired), and the -USB spec is scary. - -Discussions about the project as a whole are going on at the forum page (linked -in the title) so if you have any imput (or want to participate in the group -buy!), please stop by. :) . +### Features as of 2012-04-11 : first major release on branch 'main' +* 6KRO +* Teensy 2.0, MCP23018 I/O expander +* ~167 Hz scan rate (most of which is spent communicating via I²C) +* firmware level layers ## Dependencies (for building from source) diff --git a/src/TODO b/src/TODO index c9528a6..3e90b63 100644 --- a/src/TODO +++ b/src/TODO @@ -1,11 +1,15 @@ -+ set USB vendor ID = 0x1d50 // Openmoko, Inc. -+ set USB product ID = 0x6028 // ErgoDox ergonomic keyboard -- link to the [ErgoDox website] (http://ergodox.org/) in toplevel readme.md +// ------- -- update licence.md with "except when otherwise noted" or something similar, to +-+ link to the [ErgoDox website] (http://ergodox.org/) in toplevel readme.md + +-+ update licence.md with "except when otherwise noted" or something similar, to reflect the fact that i have code (in src/lib, and contrib) under different licences, with different authors +// ------- + - make new branch and update for fredrick's new PCB (pre-prototype)