h3n3/kiauh
1
0
Fork 0
Code Issues 46 Pull Requests 10 Packages Projects Releases Wiki Activity

README.md: update README.md

Browse Source 
Signed-off-by: Dominik Willner th33xitus@gmail.com
This commit is contained in:
th33xitus
2022-05-28 10:50:15 +02:00
parent f9d2671930
commit f09237e9f6
2 changed files with 60 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
README.md
View File

@@ -1,17 +1,24 @@
![kiauh-logo](resources/screenshots/kiauh.png) <p align="center">
# Klipper Installation And Update Helper <a>
![GitHub](https://img.shields.io/github/license/th33xitus/kiauh) <img src="https://raw.githubusercontent.com/th33xitus/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
![GitHub Repo stars](https://img.shields.io/github/stars/th33xitus/kiauh) <h1 align="center">Klipper Installation And Update Helper</h1>
![GitHub forks](https://img.shields.io/github/forks/th33xitus/kiauh) </a>
![GitHub top language](https://img.shields.io/github/languages/top/th33xitus/kiauh?logo=gnubash&logoColor=white) </p>
![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 !** <p align="center">
A handy installation script that makes installing Klipper (and more) a breeze!
**📢 Disclaimer: Usage of this script happens at your own risk!** </p>
<p align="center">
<a><img src="https://img.shields.io/github/license/th33xitus/kiauh"></a>
<a><img src="https://img.shields.io/github/stars/th33xitus/kiauh"></a>
<a><img src="https://img.shields.io/github/forks/th33xitus/kiauh"></a>
<a><img src="https://img.shields.io/github/languages/top/th33xitus/kiauh?logo=gnubash&logoColor=white"></a>
<a><img src="https://img.shields.io/github/v/tag/th33xitus/kiauh"></a>
<br />
<a><img src="https://img.shields.io/github/last-commit/th33xitus/kiauh"></a>
<a><img src="https://img.shields.io/github/contributors/th33xitus/kiauh"></a>
</p>
## **🛠️ Instructions:** ## **🛠️ Instructions:**
@@ -26,31 +33,13 @@ git clone https://github.com/th33xitus/kiauh.git
./kiauh/kiauh.sh ./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:** ## **❗ Notes:**
**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
- Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster) - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster)
- Other Debian based distributions can work - Other Debian based distributions can work
- Reported to work on Armbian too - Reported to work on Armbian too
@@ -58,16 +47,44 @@ 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: <table>
<tr>
* ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor) <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
* 🌙[Moonraker](https://github.com/Arksine/moonraker) by [Arksine](https://github.com/Arksine) <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
* 💨[Mainsail](https://github.com/mainsail-crew/mainsail) by [mainsail-crew](https://github.com/mainsail-crew) <th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
* 🌊[Fluidd](https://github.com/fluidd-core/fluidd) by [fluidd-core](https://github.com/fluidd-core) <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
* 🖥️[KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by [jordanruthe](https://github.com/jordanruthe) </tr>
* 🐙[OctoPrint](https://github.com/OctoPrint/OctoPrint) by [OctoPrint](https://github.com/OctoPrint) <tr>
* 🔬[PrettyGCode](https://github.com/Kragrathea/pgcode) by [Kragrathea](https://github.com/Kragrathea) <th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
* 🤖[Moonraker-Telegram-Bot](https://github.com/nlef/moonraker-telegram-bot) by [nlef](https://github.com/nlef) <th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
</tr>
<tr>
<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
</tr>
<tr>
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
</tr>
<tr>
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
<th><img src="https://camo.githubusercontent.com/627be7fc67195b626b298af9b9677d7c58e698c67305e54324cffbe06130d4a4/68747470733a2f2f6f63746f7072696e742e6f72672f6173736574732f696d672f6c6f676f2e706e67" alt="OctoPrint Logo" height="64"></th>
</tr>
<tr>
<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
<th>by <a href="https://github.com/nlef">nlef</a></th>
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
</tr>
</table>
## **Credits** ## **Credits**

28
docs/features.md
View File

@@ -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...