1
0
Fork 0
Ergonomic keyboard layout generator
Go to file
Tony Grosinger a19496c2cb Add upstream link to readme 2023-12-27 20:31:42 -08:00
.github Add sponsorship button 2023-05-01 13:25:16 +02:00
meta Add JSON schema 2020-10-05 22:12:13 +02:00
src Footprints I used for my keyboards 2023-12-27 20:29:10 -08:00
test Independent per-point adjustment 2023-05-20 22:03:21 +02:00
.gitignore Bundling and release prep 2020-09-27 15:11:22 +02:00
.npmrc Suppress npm warnings 2021-12-13 16:20:45 +01:00
LICENSE Improve readme formatting (#62) 2023-01-23 11:17:01 +01:00
README.md Add upstream link to readme 2023-12-27 20:31:42 -08:00
changelog.md Changelog started 2022-02-27 20:45:53 +01:00
package-lock.json 4.0.4 2023-05-20 22:07:22 +02:00
package.json 4.0.4 2023-05-20 22:07:22 +02:00
roadmap.md Independent per-point adjustment 2023-05-20 22:03:21 +02:00
rollup.config.mjs Rollup CJS changes 2023-03-18 00:04:38 +01:00
showcase.png Readme postprocessing 2023-01-23 12:19:45 +01:00

README.md

Ergogen

Upstream: https://github.com/ergogen/ergogen

Ergonomic Keyboard Generator


The project aims to provide a common configuration format to describe ergonomic 2D layouts and generate automatic plates, cases, as well as 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.





Button WebUI Button Documentation Button Discord Button Donate




Getting Started

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


  1. Read the Documentation.

    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.

    Button Official Button Unofficial

    The unofficial deployment is probably better, tbh, and will soon be replacing the official one. Choose either one, then click things, look at outputs and see if things start to make sense.

    There is no need for you to download the CLI unless you want to do one of the following:

    • Preview in-development features
    • Use custom modifications
    • Contribute code

  3. Search the ergogen topic on GitHub.

    There, you can look at (and reverse engineer) a variety of real life configs using Ergogen. Pop them into the web UI to see what they do, tinker with them and things should start to make 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 our Discord, and we can definitely find something you can help with, if you'd like to.


Sponsors

Huge thanks go to everyone who chooses to support my work! But even huger thanks are due to the following, distinguished sponsors: