Skip to content

Commit

Permalink
Improve readme formatting (ergogen#62)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
ElectronicsArchiver authored Jan 23, 2023
1 parent e0eb435 commit 357e01d
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 22 deletions.
File renamed without changes.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 68 additions & 0 deletions docs/Getting Started.md
Original file line number Diff line number Diff line change
@@ -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
Binary file added docs/Showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 0 additions & 22 deletions readme.md

This file was deleted.

0 comments on commit 357e01d

Please sign in to comment.