Improve readme formatting (#62)

* 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

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