diff --git a/README.md b/README.md index e3dafa0..5573e0a 100644 --- a/README.md +++ b/README.md @@ -20,38 +20,41 @@

-## **🛠️ Instructions:** +
-### Prerequisites -KIAUH is a script that helps you to install Klipper on a Linux Operating System that has -already been flashed to the SD card of your Raspberry Pi (or other SBC). So you need to make sure to have -a working Linux system available. A recommended Linux image (in case you are using a Raspberry Pi) is -`Raspberry Pi OS Lite (32bit)`. The easiest way to flash an image like this to an SD card is by using the -[official Raspberry Pi Imager](https://www.raspberrypi.com/software/). +

+ 📄️ Instructions 📄 +

+ +### 📋 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 (32bit)` 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 downloaded, installed and launched the Raspberry Pi Imager -select the `Choose OS` option and then `Raspberry Pi OS (other)`: \ +select `Choose OS -> Raspberry Pi OS (other)`: \ ![](resources/screenshots/rpi_imager1.png) * Then select `Raspberry Pi OS Lite (32bit)`: ![](resources/screenshots/rpi_imager2.png) -* Back in the main menu of the Raspberry Pi Imager select the corresponding SD card you want to -flash the image to. +* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which +you want to flash the image. -* Also make sure to go into the Advaced Option (the cog icon in the lower left corner) +* Make sure to go into the Advaced Option (the cog icon in the lower left corner of the main menu) and enable SSH and configure Wi-Fi. -* If you need more help for using the Raspberry Pi Imager, consider -visiting the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html). +* 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, please find out how to get an appropriate Linux image flashed -to the SD card before proceeding further. Also make sure that KIAUH will be able to run -and operate on the Linux Distribution you are going to flash. Read the Notes -further down in this document. +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. -### Download and use KIAUH +### 💾 Download and use KIAUH **📢 Disclaimer: Usage of this script happens at your own risk!** * **Step 1:** \ @@ -61,31 +64,38 @@ sudo apt-get install git -y ``` * **Step 2:** \ -Once git is installed, use the following commands in the given order to download and execute the script: +Once git is installed, use the following command to download KIAUH into your home-directoy: ```shell -cd ~ - -git clone https://github.com/th33xitus/kiauh.git - -./kiauh/kiauh.sh +cd ~ && git clone https://github.com/th33xitus/kiauh.git ``` * **Step 3:** \ -You should find yourself in the main menu of KIAUH. You will see several options you can choose -from depending on what you want to do. For choosing an option, type the corresponding number into the "Perform action" prompt. +Finally start KIAUH by running the next command: +```shell +./kiauh/kiauh.sh +``` -## **❗ Notes:** +* **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" +prompt and confirm by hitting ENTER. -**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!** +
+ +

❗ Notes ❗

+ +### **📋 Please see the [Changelog](docs/changelog.md) for possible important changes!** - Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye) - Other Debian based distributions (like Ubuntu 20 to 22) likely work too - - Reported to work on Armbian as well + - Reported to work on Armbian as well but not tested in detail - During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges. -## **🌐 Sources & Further Information** +
+ +

🌐 Sources & Further Information

@@ -157,8 +167,10 @@ from depending on what you want to do. For choosing an option, type the correspo
-## **Credits** +
+ +

✨ 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) ! +* 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!