diff --git a/README.md b/README.md index fa3c826..067ea80 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ -![kiauh-logo](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 top language](https://img.shields.io/github/languages/top/th33xitus/kiauh?logo=gnubash&logoColor=white) -![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) +

+ + KIAUH logo +

Klipper Installation And Update Helper

+ +

-### **📋 Please see the [Changelog](docs/changelog.md) for possible important information !** - -**📢 Disclaimer: Usage of this script happens at your own risk!** +

+ A handy installation script that makes installing Klipper (and more) a breeze! +

+

+ + + + + +
+ + +

## **🛠️ Instructions:** @@ -26,31 +33,13 @@ git clone https://github.com/th33xitus/kiauh.git ./kiauh/kiauh.sh ``` +**📢 Disclaimer: Usage of this script happens at your own risk!** -## **🧰 Functions and Features:** - -### **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 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. -- **Backup** of all the listed installations above. - -### **Also possible:** - -- Build the Klipper Firmware -- Flash the MCU -- Read ID of the currently connected MCU -- and more ... - -### **For a list of additional features please see: [Feature List](docs/features.md)** - ## **❗ Notes:** +**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!** + - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster) - Other Debian based distributions can work - Reported to work on Armbian too @@ -58,16 +47,44 @@ git clone https://github.com/th33xitus/kiauh.git ## **🌐 Sources & Further Information** -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) -* 🌙[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) -* 🖥️[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

Moonraker

Mainsail

Fluidd

Klipper LogoArksine avatarMainsail LogoFluidd Logo
by KevinOConnorby Arksineby mainsail-crewby fluidd-core

KlipperScreen

Moonraker-Telegram-Bot

PrettyGCode for Klipper

OctoPrint

jordanruthe avatarnlef avatarKragrathea avatarOctoPrint Logo
by jordanrutheby nlefby Kragratheaby OctoPrint
## **Credits** diff --git a/docs/features.md b/docs/features.md deleted file mode 100644 index 620ab1e..0000000 --- a/docs/features.md +++ /dev/null @@ -1,28 +0,0 @@ -# Feature List: - -- **Automatic dependency check:**\ -If packages are missing but needed for the asked task, the script will automatically install them -- **Switch between different Klipper Forks:**\ -[origin/master](https://github.com/KevinOConnor/klipper/tree/master) or [scurve-shaping](https://github.com/dmbutyugin/klipper/tree/scurve-shaping) or [scurve-smoothing](https://github.com/dmbutyugin/klipper/tree/scurve-smoothing)\ -The update function of the script will always update the currently selected/active fork! -- **Toggle auto-create backups before updating:**\ -When enabled, a backup of the installation you want to update is made prior updating -- **Rollback:**\ -When updating Klipper, KIAUH saves the current commit hash to a local ini-file. In case of an unsuccesfull update you can use this function to quickly revert back to the commit with the hash you updated from. -- **Preconfigure OctoPrint:**\ -When installing OctoPrint, a config is created which preconfigures your installation to be used with Klipper.\ -That means: - - adding the restart/shutdown commands for OctoPrint - - adding the serial port `/tmp/printer` - - set the behavior to "Cancel any ongoing prints but stay connected to the printer" -- **Enable/Disable OctoPrint Service:**\ -Usefull when using Mainsail/Fluidd and OctoPrint at the same time to prevent them interfering with each other - -- **Installing a G-Code Shell Command extension:**\ -For further information about that extension please see the [G-Code Shell Command Extension Doc](gcode_shell_command.md) - -- **Uploading logfiles:**\ -You can directly upload logfiles like klippy.log and moonraker.log from the KIAUH main menu for providing them for troubleshooting purposes. - - -to be continued...