diff --git a/license.md b/LICENSE similarity index 100% rename from license.md rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..06d4bc4 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ + +# Ergogen    [![Badge License]][License] + +***Keyboard Generator*** *build on* ***[Absolem Keyboard]***. + +
+ + + +The project aims to provide a common configuration format to
+describe ***ergonomic*** 2D layouts and generate automatic plates,
+cases, as well as un-routed PCBs for them. + +
+
+ +
+ +--- + +[![Button Demo]][Demo]    +[![Button Getting Started]][Getting Started]    +[![Button Documentation]][Documentation]    +[![Button Discord]][Discord] + +--- + +
+ +
+
+ +## Contributions + +Feature ideas, documentation improvements,
+examples, tests, or pull requests welcome! + +*Get in touch on our **[Discord]**, and we can definitely*
+*find something you can help with, if you'd like to.* + +
+ + + +[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 + + + + +[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 diff --git a/docs/Getting Started.md b/docs/Getting Started.md new file mode 100644 index 0000000..1497f57 --- /dev/null +++ b/docs/Getting Started.md @@ -0,0 +1,68 @@ +# 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]][Deployment Official]    + [![Badge Unofficial]][Deployment 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] 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. + +
+ + + + +[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 diff --git a/docs/Showcase.png b/docs/Showcase.png new file mode 100644 index 0000000..f3b928f Binary files /dev/null and b/docs/Showcase.png differ diff --git a/readme.md b/readme.md deleted file mode 100644 index 8151102..0000000 --- a/readme.md +++ /dev/null @@ -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.