jeka/kiauh
1
0
Fork 0
mirror of https://github.com/dw-0/kiauh.git synced 2025-12-13 10:34:28 +05:00
Code Issues Packages Projects Releases Wiki Activity

readme: add shields to readme

Browse Source
This commit is contained in:
th33xitus
2022-02-26 17:44:59 +01:00
committed by GitHub
parent 2f8c95a8c7
commit d8ce465126
1 changed files with 2 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,13 +1,9 @@
# **Klipper Installation And Update Helper**
![main_menu](resources/screenshots/kiauh.png) ![main_menu](resources/screenshots/kiauh.png)
# Klipper Installation And Update Helper
--- ![GitHub](https://img.shields.io/github/license/th33xitus/kiauh) ![GitHub Repo stars](https://img.shields.io/github/stars/th33xitus/kiauh) ![GitHub forks](https://img.shields.io/github/forks/th33xitus/kiauh) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/th33xitus/kiauh) ![GitHub last commit](https://img.shields.io/github/last-commit/th33xitus/kiauh) ![GitHub contributors](https://img.shields.io/github/contributors/th33xitus/kiauh)
### **📋 Please see the [Changelog](docs/changelog.md) for possible important information !** ### **📋 Please see the [Changelog](docs/changelog.md) for possible important information !**
---
**📢 Disclaimer: Usage of this script happens at your own risk!** **📢 Disclaimer: Usage of this script happens at your own risk!**
@@ -25,11 +21,9 @@ git clone https://github.com/th33xitus/kiauh.git
./kiauh/kiauh.sh ./kiauh/kiauh.sh
``` ```
---
## **🧰 Functions and Features:** ## **🧰 Functions and Features:**
---
### **Core Functions:** ### **Core Functions:**
- **Installing** Klipper to your Raspberry Pi or other Debian based Linux Distribution. - **Installing** Klipper to your Raspberry Pi or other Debian based Linux Distribution.
@@ -49,8 +43,6 @@ git clone https://github.com/th33xitus/kiauh.git
### **For a list of additional features please see: [Feature List](docs/features.md)** ### **For a list of additional features please see: [Feature List](docs/features.md)**
---
## **❗ Notes:** ## **❗ Notes:**
- Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster) - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster)
@@ -58,14 +50,10 @@ git clone https://github.com/th33xitus/kiauh.git
- Reported to work on Armbian too - Reported to work on Armbian too
- During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges. - During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges.
---
## **🌐 Sources & Further Information** ## **🌐 Sources & Further Information**
For more information or instructions to the various components KIAUH can install, please check out the corresponding repositories listed below: For more information or instructions to the various components KIAUH can install, please check out the corresponding repositories listed below:
---
* ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor) * ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor)
* 🌙[Moonraker](https://github.com/Arksine/moonraker) by [Arksine](https://github.com/Arksine) * 🌙[Moonraker](https://github.com/Arksine/moonraker) by [Arksine](https://github.com/Arksine)
* 💨[Mainsail](https://github.com/mainsail-crew/mainsail) by [mainsail-crew](https://github.com/mainsail-crew) * 💨[Mainsail](https://github.com/mainsail-crew/mainsail) by [mainsail-crew](https://github.com/mainsail-crew)
@@ -77,8 +65,6 @@ For more information or instructions to the various components KIAUH can install
* 🔬[PrettyGCode](https://github.com/Kragrathea/pgcode) by [Kragrathea](https://github.com/Kragrathea) * 🔬[PrettyGCode](https://github.com/Kragrathea/pgcode) by [Kragrathea](https://github.com/Kragrathea)
* 🤖[Moonraker-Telegram-Bot](https://github.com/nlef/moonraker-telegram-bot) by [nlef](https://github.com/nlef) * 🤖[Moonraker-Telegram-Bot](https://github.com/nlef/moonraker-telegram-bot) by [nlef](https://github.com/nlef)
---
## **Credits** ## **Credits**
* A big thank you to @lixxbox for that awesome KIAUH-Logo! * A big thank you to @lixxbox for that awesome KIAUH-Logo!