Readme postprocessing
This commit is contained in:
Bán Dénes
parent
841addb9ad
commit
c480a33fa3
88
README.md
88
README.md
@ -1,30 +1,28 @@
|
||||
|
||||
# Ergogen [![Badge License]][License]
|
||||
# Ergogen
|
||||
|
||||
***Keyboard Generator*** *build on* ***[Absolem Keyboard]***.
|
||||
***Ergonomic Keyboard Generator***
|
||||
|
||||
<br>
|
||||
|
||||
<img
|
||||
src = 'docs/Showcase.png'
|
||||
width = 300
|
||||
src = 'showcase.png'
|
||||
width = 400
|
||||
align = right
|
||||
/>
|
||||
|
||||
The project aims to provide a common configuration format to <br>
|
||||
describe ***ergonomic*** 2D layouts and generate automatic plates, <br>
|
||||
cases, as well as un-routed PCBs for them.
|
||||
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.
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<div align = center>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
---
|
||||
|
||||
[![Button Demo]][Demo]
|
||||
[![Button Getting Started]][Getting Started]
|
||||
[![Button Documentation]][Documentation]
|
||||
[![Button WebUI]][WebUI]
|
||||
[![Button Documentation]][Documentation]
|
||||
[![Button Discord]][Discord]
|
||||
|
||||
---
|
||||
@ -34,32 +32,66 @@ cases, as well as un-routed PCBs for them.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## Getting Started
|
||||
|
||||
Until there's a proper "Getting started" guide, try getting acquainted with **Ergogen** by following these steps in order:
|
||||
|
||||
<br>
|
||||
|
||||
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.
|
||||
|
||||
<br>
|
||||
|
||||
2. Try one of the web-based deployments.
|
||||
|
||||
[![Button Official]][WebUI]
|
||||
[![Button Unofficial]][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
|
||||
|
||||
<br>
|
||||
|
||||
3. Search the [`ergogen`][Topic] 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.
|
||||
|
||||
<br>
|
||||
|
||||
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.
|
||||
|
||||
<br>
|
||||
|
||||
## Contributions
|
||||
|
||||
Feature ideas, documentation improvements, <br>
|
||||
examples, tests, or pull requests welcome!
|
||||
|
||||
*Get in touch on our **[Discord]**, and we can definitely* <br>
|
||||
*find something you can help with, if you'd like to.*
|
||||
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.
|
||||
|
||||
<br>
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
|
||||
|
||||
[Absolem Keyboard]: https://zealot.hu/absolem
|
||||
[Getting Started]: docs/Getting%20Started.md
|
||||
[Absolem keyboard]: https://zealot.hu/absolem
|
||||
[Documentation]: https://docs.ergogen.xyz
|
||||
[Discord]: https://discord.gg/nbKcAZB
|
||||
[Demo]: https://ergogen.xyz
|
||||
|
||||
[License]: LICENSE
|
||||
|
||||
[Discord]: http://discord.ergogen.xyz
|
||||
[WebUI]: https://ergogen.xyz
|
||||
[Unofficial]: https://ergogen.cache.works/
|
||||
[Topic]: https://github.com/topics/ergogen
|
||||
|
||||
<!--------------------------------{ Buttons }---------------------------------->
|
||||
|
||||
[Button Getting Started]: https://img.shields.io/badge/Getting_Started-F94877?style=for-the-badge&logoColor=white&logo=GitHub
|
||||
[Button WebUI]: https://img.shields.io/badge/Deployment-37a779?style=for-the-badge&logoColor=white&logo=AppleArcade
|
||||
[Button Unofficial]: https://img.shields.io/badge/Unofficial-yellow?style=for-the-badge
|
||||
[Button Official]: https://img.shields.io/badge/Official-37a779?style=for-the-badge
|
||||
[Button Documentation]: https://img.shields.io/badge/Documentation-1793D1?style=for-the-badge&logoColor=white&logo=GitBook
|
||||
[Button Discord]: https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logoColor=white&logo=Discord
|
||||
[Button Demo]: https://img.shields.io/badge/Demo-37a779?style=for-the-badge&logoColor=white&logo=AppleArcade
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
# Getting Started
|
||||
|
||||
Until a proper 'Getting started' guide has been written, <br>
|
||||
try getting familiar with **Ergogen** doing the following:
|
||||
|
||||
<br>
|
||||
|
||||
1. Read the **[Documentation]**.
|
||||
|
||||
*It isn't complete by any measure, but should give* <br>
|
||||
*you a fairly good idea what you are dealing with.*
|
||||
|
||||
<br>
|
||||
|
||||
2. Try one of the web-based deployments.
|
||||
|
||||
[![Badge Official]][Deployment Official]
|
||||
[![Badge Unofficial]][Deployment Unofficial]
|
||||
|
||||
<br>
|
||||
|
||||
*The unofficial deployment is probably* <br>
|
||||
*better and will soon be official as well.*
|
||||
|
||||
#### CLI
|
||||
|
||||
There is no need for you to download the **CLI** <br>
|
||||
unless you want to do one of the following:
|
||||
|
||||
- Preview in-development features
|
||||
- Use custom modifications
|
||||
- Contribute code
|
||||
|
||||
<br>
|
||||
|
||||
*Click things, look at outputs and* <br>
|
||||
*see if things start to make sense.*
|
||||
|
||||
<br>
|
||||
|
||||
3. Search the [`ergogen`][Topic] topic on GitHub <br>
|
||||
to look at / reverse engineer a variety <br>
|
||||
of real life configs using **Ergogen**.
|
||||
|
||||
Pop them into the web UI to see what <br>
|
||||
they do, tinker with them and things <br>
|
||||
should start to make more sense.
|
||||
|
||||
<br>
|
||||
|
||||
4. If a question persists after all of the above, <br>
|
||||
feel free to ask it over on **[Discord]** and we'll <br>
|
||||
do our best to help you out.
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Badge Unofficial]: https://img.shields.io/badge/Unofficial-E4405F.svg?style=for-the-badge
|
||||
[Badge Official]: https://img.shields.io/badge/Official-yellow.svg?style=for-the-badge
|
||||
|
||||
[Deployment Unofficial]: https://ergogen.cache.works/
|
||||
[Deployment Official]: https://ergogen.xyz
|
||||
|
||||
[Documentation]: https://docs.ergogen.xyz
|
||||
[Discord]: https://discord.gg/nbKcAZB
|
||||
[Topic]: https://github.com/topics/ergogen
|
||||
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Loading…
Reference in New Issue
Block a user