foosinn/ergogen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

De-dupe readme, point usage to docs

Browse source
This commit is contained in:
Bán Dénes 2022-01-20 11:33:11 +01:00
parent 47d15c0261
commit f326594743
1 changed files with 1 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

20
readme.md
View file

@ -3,25 +3,7 @@
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](https://zealot.hu/absolem), and shares its [Discord server](https://discord.gg/nbKcAZB) as well.
## Usage
Supposing you have a config ready, you can use ergogen either on the command line, or through the [web UI](https://ergogen.xyz).
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](https://ergogen.xyz) 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](https://docs.ergogen.xyz).
For usage and config information, please refer to the [docs](https://docs.ergogen.xyz).
## Contributions