foosinn/ergogen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ergogen/docs/Getting Started.md
トトも 357e01d639
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
2023-01-23 11:17:01 +01:00

1.8 KiB
Raw Blame History

Getting Started

Until a proper 'Getting started' guide has been written,
try getting familiar with Ergogen doing the following:


  1. Read the Documentation.

    It isn't complete by any measure, but should give
    you a fairly good idea what you are dealing with.


  2. Try one of the web-based deployments.

    Badge Official    Badge Unofficial


    The unofficial deployment is probably
    better and will soon be official as well.

    CLI

    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

    Click things, look at outputs and
    see if things start to make sense.


  3. Search the ergogen topic on GitHub
    to look at / 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.


  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.