357e01d639
* Fixed LICENSE File Name * Adjusted README Name * Formatted Contribution Section * Added License Badge * Formatted Getting Started * Moved Getting Started Into Dedicated File * Added Quicklinks * Fixed File Name * Formatted Description + Added Showcase * Adjusted Image Padding * Adjusted Spacing
65 lines
1.7 KiB
Markdown
65 lines
1.7 KiB
Markdown
|
||
# Ergogen [![Badge License]][License]
|
||
|
||
***Keyboard Generator*** *build on* ***[Absolem Keyboard]***.
|
||
|
||
<br>
|
||
|
||
<img
|
||
src = 'docs/Showcase.png'
|
||
width = 300
|
||
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.
|
||
|
||
<br>
|
||
<br>
|
||
|
||
<div align = center>
|
||
|
||
---
|
||
|
||
[![Button Demo]][Demo]
|
||
[![Button Getting Started]][Getting Started]
|
||
[![Button Documentation]][Documentation]
|
||
[![Button Discord]][Discord]
|
||
|
||
---
|
||
|
||
</div>
|
||
|
||
<br>
|
||
<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.*
|
||
|
||
<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
|
||
[Documentation]: https://docs.ergogen.xyz
|
||
[Discord]: https://discord.gg/nbKcAZB
|
||
[Demo]: https://ergogen.xyz
|
||
|
||
[License]: LICENSE
|
||
|
||
|
||
<!--------------------------------{ Buttons }---------------------------------->
|
||
|
||
[Button Getting Started]: https://img.shields.io/badge/Getting_Started-F94877?style=for-the-badge&logoColor=white&logo=GitHub
|
||
[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
|