diff --git a/README.md b/README.md index 74df0a7..72ece02 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,12 @@ ### 📋 Prerequisites KIAUH is a script that assists you in installing Klipper on a Linux operating system that has -already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure -that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image -if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/) +already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure +that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image +if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/) is the simplest way to flash an image like this to an SD card. -* Once you have downloaded, installed and launched the Raspberry Pi Imager, +* Once you have downloaded, installed and launched the Raspberry Pi Imager, select `Choose OS -> Raspberry Pi OS (other)`: \

KIAUH logo @@ -44,7 +44,7 @@ select `Choose OS -> Raspberry Pi OS (other)`: \ KIAUH logo

-* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which +* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which you want to flash the image. * Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu) @@ -52,9 +52,9 @@ and enable SSH and configure Wi-Fi. * If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html). -These steps **only** apply if you are actually using a Raspberry Pi. In case you want -to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed -to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run +These steps **only** apply if you are actually using a Raspberry Pi. In case you want +to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed +to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run and operate on the Linux Distribution you are going to flash. You likely will have the most success with distributions based on Debian 11 Bullseye. Read the notes further down below in this document. @@ -82,8 +82,8 @@ Finally, start KIAUH by running the next command: ``` * **Step 4:** \ -You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending -on what you want to do. To choose an action, simply type the corresponding number into the "Perform action" +You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending +on what you want to do. To choose an action, simply type the corresponding number into the "Perform action" prompt and confirm by hitting ENTER.
@@ -101,77 +101,83 @@ prompt and confirm by hitting ENTER.

🌐 Sources & Further Information

- +
- - - + + + - - - + + + - - - - - - - - - - - - - - - - - - + + + - - - + + + + + + + + + + + + + - - - + + + + + + + + + + + + + - - - + + + + + + + + + + + + + - - - - + + - - - - + + - - - - - + + - -

Klipper

Moonraker

Mainsail

Klipper

Moonraker

Mainsail

Klipper LogoArksine avatarMainsail LogoKlipper LogoArksine avatarMainsail Logo
by KevinOConnorby Arksineby mainsail-crew

Fluidd

KlipperScreen

OctoPrint

Fluidd Logojordanruthe avatarOctoPrint Logo
by fluidd-coreby jordanrutheby OctoPrintby KevinOConnorby Arksineby mainsail-crew

Moonraker-Telegram-Bot

PrettyGCode for Klipper

Obico for Klipper

Fluidd

KlipperScreen

OctoPrint

Fluidd Logojordanruthe avatarOctoPrint Logo
by fluidd-coreby jordanrutheby OctoPrint
nlef avatarKragrathea avatarObico logo

Moonraker-Telegram-Bot

PrettyGCode for Klipper

Obico for Klipper

nlef avatarKragrathea avatarObico logo
by nlefby Kragratheaby Obico
by nlefby Kragratheaby Obico

Mobileraker's Companion

OctoEverywhere For Klipper

OctoApp For Klipper

Mobileraker LogoOctoEverywhere LogoOctoApp Logo
by Patrick Schmidtby Quinn Damerellby Christian Würthner

Mobileraker's Companion

OctoEverywhere For Klipper

OctoApp For Klipper

Klipper-Backup

SimplyPrint for Klipper

OctoEverywhere LogoOctoEverywhere LogoOctoApp LogoStaubgeroner Avatar
by Patrick Schmidtby Quinn Damerellby Christian Würthnerby Staubgeborenerby SimplyPrint

@@ -186,6 +192,12 @@ prompt and confirm by hitting ENTER.
+
+ Repobeats analytics image +
+ +
+

✨ Credits ✨

* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!