Update README.md

This commit is contained in:
th33xitus
2020-09-18 09:00:32 +02:00
parent 78dcc0a1ad
commit c55a010bcd

View File

@@ -32,6 +32,7 @@ chmod +x kiauh.sh scripts/*
``` ```
## Additional Instructions: ## Additional Instructions:
If you need some more detailed instructions on how to install Klipper and Mainsail with KIAUH, check out this website: 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) [Installing Klipper and Mainsail](https://3dp.tumbleweedlabs.com/firmware/klipper-firmware/installing-klipper-and-mainsail-on-your-raspberry-pi)
@@ -47,14 +48,15 @@ Feel free to check out his work.
- **Installing** of the Klipper Firmware to your Raspberry Pi or other Linux Distribution which makes use of init.d. - **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 or OctoPrint including their dependencies.
- **Installing** of the Moonraker API - **Installing** of the Moonraker API
- **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface! - **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface!
- **Removing** of all the listed installations above. - **Removing** of all the listed installations above.
- **Backup** of all the listed installations above. - **Backup** of all the listed installations above.
What also is possible: What also is possible:
- Build the Klipper Firmware - Build the Klipper Firmware
- Flash the MCU - Flash the MCU
- Read ID of the currently connected printer (only one at the time) - Read ID of the currently connected printer (only one at the time)
- Write necessary entries to your printer.cfg, some of them customizable right in the CLI. - Write necessary entries to your printer.cfg, some of them customizable right in the CLI.
@@ -65,7 +67,7 @@ For a list of additional features and their descriptions please see:
## Notes: ## Notes:
- Important changes to the script will be listet in the [Changelog](https://github.com/th33xitus/kiauh/blob/master/docs/changelog.md) - 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 - Tested only on Raspbian Buster Lite
- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges. - During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
- Prevent simultaneous use of DWC2 and OctoPrint if possible. There have been reports that DWC2 does strange things while the OctoPrint service is running while using the DWC2 webinterface. The script disables an existing OctoPrint service when installing DWC2. However, the service can also be reactivated with the script! - Prevent simultaneous use of DWC2 and OctoPrint if possible. There have been reports that DWC2 does strange things while the OctoPrint service is running while using the DWC2 webinterface. The script disables an existing OctoPrint service when installing DWC2. However, the service can also be reactivated with the script!