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

Redirect readme links to new domain

Browse source
This commit is contained in:
Bán Dénes 2021-11-27 21:08:28 +01:00
parent e29613dfe5
commit e58b80c2a9
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
readme.md
View file

@ -10,15 +10,15 @@ The project grew out of (and is an integral part of) the [Absolem keyboard](http
## Usage ## Usage
Supposing you have a config ready, you can use ergogen either on the command line, or through the [web UI](https://zealot.hu/ergogen/). 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`. 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 `--help` switch lists the available command line options.
The [web UI](https://zealot.hu/ergogen/) is a more accessible version of the same codebase, where everything happens in your browser. 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! 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://github.com/mrzealot/ergogen/blob/master/docs/reference.md), or browse the [`docs`](https://github.com/mrzealot/ergogen/tree/master/docs) folder for additional examples. As for how to prepare a valid config, please read the [reference](https://docs.ergogen.xyz).