muflax
/
ergodox-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

partial-rewrite
Ben Blazak 2013-08-04 13:11:58 -07:00
parent 6a13099a71
commit fbbd4570d4
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
readme.md
View File

@ -4,16 +4,24 @@ This branch is currently under development, and all parts are subject to
change. I'll do my very best to keep the latest commit working properly
though.
*Pull requests will almost certainly not be accepted for this branch at this
time.*
Sorry... It's a bit hard to explain exactly why... But perhaps it will be
Source level documentation is being written with the code. Other documentation
(including a better readme), even though it's just as necessary, will be
written afterwards.
**Pull requests for this branch will almost certainly not be accepted at this
time.**
Sorry. It's a bit hard to explain exactly why. Perhaps it will be
understandable if I just say that I've been working on this project for quite a
long time now, and at this point rev-2 is kind of my baby. Until it grows up,
and I send it out into the real world by moving it to the master branch, I feel
very protective of it.
while now, and at this point rev-2 is kind of my baby. One of my goals for it
is to not only have it work and have decent features, but be well designed and
well documented to the point that someone starting out where I did could pick
it up and learn without having to write their own. Until it grows up, and I
send it out into the real world by moving it to the master branch, I'm likely
to feel very protective of it.
Notes:
* Gyuri Horak implemented NKRO and mouse keys in [his branch]
(https://github.com/dyuri/ergodox-firmware) of rev-2. Not merged, but I plan
to implement the features later, if I can. See [Pull Request #28]
(https://github.com/benblazak/ergodox-firmware/pull/28).