mirror of
https://github.com/dw-0/kiauh.git
synced 2025-12-15 03:24:29 +05:00
94 lines
4.4 KiB
Markdown
94 lines
4.4 KiB
Markdown
<p align="center">
|
|
<a>
|
|
<img src="https://raw.githubusercontent.com/th33xitus/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
|
|
<h1 align="center">Klipper Installation And Update Helper</h1>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
A handy installation script that makes installing Klipper (and more) a breeze!
|
|
</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:**
|
|
|
|
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.\
|
|
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
|
|
```
|
|
**📢 Disclaimer: Usage of this script happens at your own risk!**
|
|
|
|
|
|
## **❗ 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
|
|
- 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**
|
|
|
|
<table>
|
|
<tr>
|
|
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
|
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
|
<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
|
|
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
|
</tr>
|
|
<tr>
|
|
<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
|
|
<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**
|
|
|
|
* A big thank you to [lixxbox](https://github.com/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!
|