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

Update README.md

Browse Source
This commit is contained in:
th33xitus
2020-10-06 22:29:03 +02:00
parent 6142c0c18f
commit ab6fa29bd2
5 changed files with 68 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

@@ -1,27 +1,24 @@
# KIAUH - Klipper Installation And Update Helper
### ( This script is always work in progress! )
![main_menu](https://github.com/th33xitus/kiauh/blob/master/resources/screenshots/main.png)
---
## Disclaimer: Usage of this script happens at your own risk!
This script is "only" a helping hand for you to get set up in a fast and most comfortable way.
**This does not mean, it will relieve you of using brain.exe!**
## 📢 Disclaimer: Usage of this script happens at your own risk!
This script is "only" a helping hand for you to get set up in a fast and most comfortable way.\
**This does not mean, it will relieve you of using brain.exe! 🧠**\
Feel free to give it a try if you want. If you have suggestions or encounter any problems, please report them.
---
## Instructions:
## 🛠️ Instructions:
For downloading this script it is best to have git already installed.
If you haven't, please run `sudo apt-get install git -y` to install git first. You will need it anyways!
For downloading this script it is best to have git already 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.
After git is installed, use the following commands in the given order to download and execute the script:
```shell
cd ~
@@ -31,23 +28,21 @@ chmod +x kiauh.sh scripts/*
./kiauh.sh
```
## Additional Instructions:
### Additional Instructions:
If you need some more detailed instructions on how to install Klipper and Mainsail with KIAUH, check out this website:
[Installing Klipper and Mainsail](https://3dp.tumbleweedlabs.com/firmware/klipper-firmware/installing-klipper-and-mainsail-on-your-raspberry-pi)
Credits for these instructions go to [@tumbleweedlabs](https://github.com/tumbleweedlabs).
If you need some more detailed instructions on how to install Klipper and Mainsail with KIAUH, check out this website:\
[Installing Klipper and Mainsail](https://3dp.tumbleweedlabs.com/firmware/klipper-firmware/installing-klipper-and-mainsail-on-your-raspberry-pi)\
Credits for these instructions go to [@tumbleweedlabs](https://github.com/tumbleweedlabs).\
Feel free to check out his work.
---
## Functions and Features:
## 🧰 Functions and Features:
### Core Functions:
- **Installing** of the Klipper Firmware to your Raspberry Pi or other Linux Distribution which makes use of init.d.
- **Installing** of several different web interfaces such as Duet Web Control, Mainsail or OctoPrint including their dependencies.
- **Installing** of several different web interfaces such as Duet Web Control, Mainsail, Fluidd or OctoPrint including their dependencies.
- **Installing** of the Moonraker API
- **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface!
- **Removing** of all the listed installations above.
@@ -65,7 +60,7 @@ For a list of additional features and their descriptions please see:
---
## Notes:
## 📝 Notes:
- Important changes to the script will be listed in the [Changelog](https://github.com/th33xitus/kiauh/blob/master/docs/changelog.md)
- Tested only on Raspbian Buster Lite
@@ -75,41 +70,63 @@ For a list of additional features and their descriptions please see:
---
### For more information or instructions, please check out the appropriate repositories listed below:
## 🛈 Sources & Further Information
Klipper by [KevinOConnor](https://github.com/KevinOConnor) :
- https://github.com/KevinOConnor/klipper
Klipper S-Curve fork by [dmbutyugin](https://github.com/dmbutyugin) :
- 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
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
OctoPrint Webinterface by [OctoPrint](https://github.com/OctoPrint) :
- https://octoprint.org
- https://github.com/OctoPrint/OctoPrint
For more information or instructions, please check out the appropriate repositories listed below:
---
## Q&A
**⛵Klipper** by [KevinOConnor](https://github.com/KevinOConnor) :
https://github.com/KevinOConnor/klipper
---
**⛵Klipper S-Curve fork** by [dmbutyugin](https://github.com/dmbutyugin) :
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
---
**🐙OctoPrint Webinterface** by [OctoPrint](https://github.com/OctoPrint) :
https://octoprint.org\
https://github.com/OctoPrint/OctoPrint
---
## ❓ FAQ
**_Q: Can i use this script to install multiple instancec of Klipper on the same Pi? (Multisession?)_**