Giter VIP home page Giter VIP logo

ergogen's Introduction

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.

ergogen's People

Contributors

albert-iv avatar brow avatar fanchgadjo avatar merlin04 avatar mrzealot avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.