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

Improve readme formatting (#62)

Browse source 
* 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
This commit is contained in:
トトも 2023-01-23 05:17:01 -05:00 • committed by GitHub
parent e0eb43566f
commit 357e01d639
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 133 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

0
license.md → LICENSE
View file

65
README.md Normal file
View file

@ -0,0 +1,65 @@
# 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

68
docs/Getting Started.md Normal file
View file

@ -0,0 +1,68 @@
# 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

BIN
docs/Showcase.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 42 KiB

22
readme.md
View file

@ -1,22 +0,0 @@
# 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](https://zealot.hu/absolem), and shares its [Discord server](https://discord.gg/nbKcAZB) as well.
## Getting started
Until there's a proper "Getting started" guide, try getting acquainted with ergogen by following these steps in order:
1. Read the [docs](https://docs.ergogen.xyz). D'uuh. They're not complete by any measure, but should give you a fairly good idea what you're dealing with here.
1. Try one of the web-based deployments ([official](https://ergogen.xyz); [unofficial](https://ergogen.cache.works/) but probably better and soon to be official) - no need to download the CLI unless you want to A) preview in-development features, B) use custom modifications, or C) contribute code. Click things, look at outputs; see if things start to make sense.
1. Search the [`#ergogen`](https://github.com/topics/ergogen) topic on GitHub to look at (and reverse engineer) a variety of real life configs using ergogen. Pop them into the web UI, see what they do, tinker with them; things should start to make more and more sense.
1. If a question persists after all of the above, feel free to ask it over on [Discord](https://discord.gg/nbKcAZB) and we'll do our best to help you out.
## Contributions
Feature ideas, documentation improvements, examples, tests, or pull requests welcome!
Get in touch [on Discord](https://discord.gg/nbKcAZB), and we can definitely find something you can help with, if you'd like to.