- new ergodox website - clarification in licence indicating that parts of the project may not be under that license/copyright - currently the stuff in src/lib, and soon the stuff in contrib, (are|will be) under different copyrights, and possibly different licenses. - also, just so it's written down somewhere: some of my documentation may be considered derivative works of the specs|docs i was taking things from, but i hope i'm safe (fair use?). i tried to make clear in each file where i got stuff though.
|8 years ago|
|contrib||8 years ago|
|src||8 years ago|
|license.md||8 years ago|
|makefile||8 years ago|
|readme.md||8 years ago|
|references.md||8 years ago|
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.
If you're viewing this on github, please note that directory links will only work if you're viewing this from the directory, and file links will only work if you're viewing this as a file. This is true for all the '.md' files here. The limitation is due to the way github addresses directories and files, and the fact that Markdown doesn't have any way (that I know of) to rewrite the URLs as would be required.
This project is definitely in beta, but I'll do my best to keep the 'master' branch working. Please see the source (and especially the accompanying '.md' files) for documentation. And [references.md] (references.md) contains lots of good links, along with descriptions.
If you're just trying to compile, jump to the bottom of the file and read the [Dependencies] (#dependencies-for-building-from-source) section. Once that's taken care of, navigate to the [src] (src) directory, compile using Make, and fire up your teensy loader to transfer the '.hex' file. Just to be safe, you should also check the '.eep' file. If it's larger than 0 bytes, you need to load it too.
If you're looking to hack on the source, or just feel like reading it, you probably don't need much direction for a small project like this. I'll try to write more later (for people who are new to AVR programming, like I was when I started this project), but for now:
Open issues, feature requests, and such are tracked [on github] (/benblazak/ergodox-firmware/issues).
See the PJRC [Getting Started] (http://pjrc.com/teensy/first_use.html) page for instructions on how to set up an AVR programming environment. This project uses C (not Arduino), and Make. I'm compiling with GNU tools under Ubuntu, but other environments (especially [WinAVR] (http://winavr.sourceforge.net/) under Windows) should work too.
I also assume that you are using [git] (http://git-scm.com/) (for