manuelkoester / ergogen

Ergonomic keyboard layout generator

Ergogen

Ergogen is a keyboard generator that aims to provide a common configuration format to describe ergonomic 2D layouts, and generate automatic plates, cases, and (un-routed) PCBs for them. The project grew out of (and is an integral part of) the Absolem keyboard, and shares its Discord server as well.

Getting started

Until there's a proper "Getting started" guide, try getting acquainted with ergogen by following these steps in order:

1. Read the docs. D'uuh. They're not complete by any measure, but should give you a fairly good idea what you're dealing with here.

2. Try one of the web-based deployments (official; unofficial but probably better and soon to be official) - no need to download the CLI unless you want to A) preview in-development features, B) use custom modifications, or C) contribute code. Click things, look at outputs; see if things start to make sense.

3. Search the #ergogen topic on GitHub to look at (and reverse engineer) a variety of real life configs using ergogen. Pop them into the web UI, see what they do, tinker with them; things should start to make more and more sense.

4. If a question persists after all of the above, feel free to ask it over on Discord and we'll do our best to help you out.

Contributions

Feature ideas, documentation improvements, examples, tests, or pull requests welcome! Get in touch on Discord, and we can definitely find something you can help with, if you'd like to.