tgrosinger/ergogen
1
0
Fork 0
Code
Ergonomic keyboard layout generator
54 Commits 1 Branch 0 Tags 734 KiB
JavaScript 100%
f8223aa986
Go to file
Tom Brow f8223aa986 output SVG alongside DXF in debug mode
2020-11-03 10:44:38 +01:00
docs Added example configuration from Absolum project. 2020-10-18 22:05:04 +02:00
meta Add JSON schema 2020-10-05 22:12:13 +02:00
src output SVG alongside DXF in debug mode 2020-11-03 10:44:38 +01:00
test Minor test catch-up 2020-07-21 19:45:01 +02:00
.gitignore Bundling and release prep 2020-09-27 15:11:22 +02:00
license.md Docs cleanup 2020-10-18 13:41:06 +02:00
package-lock.json Bundling and release prep 2020-09-27 15:11:22 +02:00
package.json Bundling and release prep 2020-09-27 15:11:22 +02:00
readme.md Minor doc fix 2020-11-01 16:44:31 +01:00
rollup.config.js Bundling and release prep 2020-09-27 15:11:22 +02:00

readme.md

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.

Usage

Supposing you have a config ready, you can use ergogen either on the command line, or through the web UI.

Command line usage requires node v14.4.0+ with npm v6.14.5+ to be installed, the repo to be checked out, npm install to be issued, and then simply calling the CLI interface through node src/cli.js. The --help switch lists the available command line options.

The web UI is a more accessible version of the same codebase, where everything happens in your browser. It's been patched together on a fresh Chrome-derivative, and I didn't take any care to make it compatible with older stuff, so please use something modern!

As for how to prepare a valid config, please read the reference, or browse the docs folder for additional examples.

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.