local fork of ergogen.xyz w/ nix flake
Go to file
Ryan Rix d7111cb5df add option to specify the MCU i use as a SMD paste job 2024-05-16 10:29:09 -07:00
.github Add sponsorship button 2023-05-01 13:25:16 +02:00
meta add nice!nano v2 footprint 2024-05-15 18:04:34 -07:00
src add option to specify the MCU i use as a SMD paste job 2024-05-16 10:29:09 -07:00
test Prevent circular dependencies in $extends 2024-04-14 18:07:30 +02:00
.gitignore Injectable PCB templates 2024-01-23 12:04:37 +01: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 Update unofficial WebUI link to point to https://ergogen.ceoloide.com 2024-05-13 09:52:19 +02:00
changelog.md Changelog started 2022-02-27 20:45:53 +01:00
default.nix nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
flake.lock nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
flake.nix nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
node-env.nix nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
node-packages.nix nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
package-lock.json nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
package.json nix build, had to disable KLE import 2024-05-15 18:04:55 -07:00
roadmap.md Prevent circular dependencies in $extends 2024-04-14 18:07:30 +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

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: