diff --git a/README.md b/README.md index f717173..747f60f 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,27 @@ -# **KIAUH - Klipper Installation And Update Helper** +# **Klipper Installation And Update Helper** -![main_menu](resources/screenshots/main_v3.png) +![main_menu](resources/screenshots/kiauh.png) --- -## **📋 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!** -This script acts as a helping hand for you to get set up in a fast and comfortable way.\ -**This does not mean, it will relieve you of using your brain.exe! 🧠**\ -Please also always pay attention to the individual component repositories (all linked below).\ -Feel free to give it a try. If you have suggestions or encounter any problems, please report them. - ---- ## **🛠️ Instructions:** For downloading this script it is necessary to have git installed.\ If you haven't, please run `sudo apt-get install git -y` to install git first.\ -You will need it anyways! 😄 - After git is installed, use the following commands in the given order to download and execute the script: ```shell cd ~ + git clone https://github.com/th33xitus/kiauh.git + ./kiauh/kiauh.sh ``` @@ -35,13 +29,12 @@ git clone https://github.com/th33xitus/kiauh.git ## **🧰 Functions and Features:** -- **New in v3.0.0:** You can now install multiple instances (Klipper/Moonraker/DWC/Octoprint) on the same Pi! --- ### **Core Functions:** - **Installing** Klipper to your Raspberry Pi or other Debian based Linux Distribution. - **Installing** of the Moonraker API (needed for Mainsail, Fluidd and KlipperScreen) -- **Installing** several different web interfaces such as Mainsail, Fluidd, Duet Web Control or OctoPrint including their dependencies. +- **Installing** several web interfaces such as Mainsail, Fluidd, Duet Web Control or OctoPrint including their dependencies. - **Installing** of KlipperScreen (OctoScreen but for Klipper!) - **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface! - **Removing** of all the listed installations above. @@ -58,7 +51,7 @@ git clone https://github.com/th33xitus/kiauh.git --- -## **📝 Notes:** +## **❗ Notes:** - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster) - Other Debian based distributions can work @@ -67,82 +60,27 @@ git clone https://github.com/th33xitus/kiauh.git --- -## **🛈 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: --- -### **⛵Klipper** by [KevinOConnor](https://github.com/KevinOConnor) : - -https://github.com/Klipper3d/klipper +* ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor) +* 🌙[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) +* 🌊[Fluidd](https://github.com/fluidd-core/fluidd) by [fluidd-core](https://github.com/fluidd-core) +* 🕸️[Duet Web Control](https://github.com/Duet3D/DuetWebControl) by [Duet3D](https://github.com/Duet3D) +* 🕸️[DWC2-for-Klipper-Socket](https://github.com/Stephan3/dwc2-for-klipper-socket) by [Stephan3](https://github.com/Stephan3) +* 🖥️[KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by [jordanruthe](https://github.com/jordanruthe) +* 🐙[OctoPrint](https://github.com/OctoPrint/OctoPrint) by [OctoPrint](https://github.com/OctoPrint) +* 🔬[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) --- -### **⛵Klipper S-Curve fork** by [dmbutyugin](https://github.com/dmbutyugin) : +## **Credits** -https://github.com/dmbutyugin/klipper/tree/scurve-smoothing \ -https://github.com/dmbutyugin/klipper/tree/scurve-shaping - ---- - -### **🌙Moonraker** by [Arksine](https://github.com/Arksine) : - -https://github.com/Arksine/moonraker - ---- - -### **💨Mainsail Webinterface** by [meteyou](https://github.com/meteyou) : - -https://github.com/meteyou/mainsail - ---- - -### **🌊Fluidd Webinterface** by [cadriel](https://github.com/cadriel) : - -https://github.com/cadriel/fluidd - ---- - -### **🕸️Duet Web Control** by [Duet3D](https://github.com/Duet3D) : - -https://github.com/Duet3D/DuetWebControl - ---- - -### **🕸️DWC2-for-Klipper-Socket** by [Stephan3](https://github.com/Stephan3) : - -https://github.com/Stephan3/dwc2-for-klipper-socket - ---- - -### **🖥️KlipperScreen** by [jordanruthe](https://github.com/jordanruthe) : - -https://github.com/jordanruthe/KlipperScreen - ---- - -### **🐙OctoPrint Webinterface** by [OctoPrint](https://github.com/OctoPrint) : - -https://octoprint.org \ -https://github.com/OctoPrint/OctoPrint - ---- - -### **🔬PrettyGCode for Klipper** by [Kragrathea](https://github.com/Kragrathea) : - -https://github.com/Kragrathea/pgcode - ---- - -### **🤖Telegram Bot for Moonraker** by [nlef](https://github.com/nlef) : - -https://github.com/nlef/moonraker-telegram-bot - ---- - -## **❓ FAQ** - -**_Q: Can i use this script to install multiple instances of Klipper on the same Pi? (Multisession?)_** - -**A:** Yes, it is finally possible 🙂 +* A big thank you to @lixxbox for that awesome KIAUH-Logo! +* Also a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/th33xitus) ! +* Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project! diff --git a/resources/screenshots/kiauh.png b/resources/screenshots/kiauh.png new file mode 100644 index 0000000..7c1b978 Binary files /dev/null and b/resources/screenshots/kiauh.png differ diff --git a/resources/screenshots/main_v3.png b/resources/screenshots/main_v3.png deleted file mode 100644 index b8486e6..0000000 Binary files a/resources/screenshots/main_v3.png and /dev/null differ