update docs

Signed-off-by: Stefan Dej <meteyou@gmail.com>
This commit is contained in:
Stefan Dej
2020-11-28 02:31:38 +01:00
parent d13642cfd2
commit 8f11d50915
11 changed files with 151 additions and 18 deletions

View File

@@ -2,14 +2,14 @@
Mainsail is a lightweight & responsive web interface for the [Klipper](https://github.com/KevinOConnor/klipper)
3D printer firmware. It communicates with the [Moonraker (Klipper-API)](https://github.com/arksine/moonraker) from [Arksine](https://github.com/arksine).
![screenshot-dashboard](docs/images/screenshot-dashboard.png)
![screenshot-dashboard](docs/assets/img/screenshot.png)
To begin using Mainsail start by [installing](https://github.com/meteyou/mainsail/wiki/Installation) it or read the [Wiki Pages](https://github.com/meteyou/mainsail/wiki) for more informations.
## Credit, sources and inspiration
* [Kevin O'Connor](https://github.com/KevinOConnor) for the awesome 3D printer firmware [Klipper](https://github.com/KevinOConnor/klipper)
* [Eric Callahan (arksine)](https://github.com/Arksine) for [Moonraker (Klipper API)](https://github.com/Arksine/moonraker). Without Moonraker, Mainsail would not be possible.
* [lixxbox](https://github.com/lixxbox) for the Mainsail logo
* [lixxbox](https://github.com/lixxbox) for the Mainsail logo & Docs
* [Vue.js](https://vuejs.org/): The Progressive JavaScript Framework
* [Vuetify](https://vuetifyjs.com/): Material Design Component Framework for Vue.js