mirror of
https://github.com/dw-0/kiauh.git
synced 2025-12-11 17:44:28 +05:00
readme: add prerequisites to readme (#309)
This commit is contained in:
92
README.md
92
README.md
@@ -20,32 +20,86 @@
|
||||
<a><img src="https://img.shields.io/github/contributors/th33xitus/kiauh"></a>
|
||||
</p>
|
||||
|
||||
## **🛠️ Instructions:**
|
||||
<hr>
|
||||
|
||||
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:
|
||||
<h2 align="center">
|
||||
📄️ Instructions 📄
|
||||
</h2>
|
||||
|
||||
```shell
|
||||
cd ~
|
||||
### 📋 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.
|
||||
|
||||
git clone https://github.com/th33xitus/kiauh.git
|
||||
* Once you downloaded, installed and launched the Raspberry Pi Imager
|
||||
select `Choose OS -> Raspberry Pi OS (other)`: \
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/th33xitus/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
|
||||
</p>
|
||||
|
||||
./kiauh/kiauh.sh
|
||||
```
|
||||
* Then select `Raspberry Pi OS Lite (32bit)`:
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/th33xitus/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
|
||||
</p>
|
||||
|
||||
* 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 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, 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
|
||||
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
|
||||
**📢 Disclaimer: Usage of this script happens at your own risk!**
|
||||
|
||||
* **Step 1:** \
|
||||
To download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:
|
||||
```shell
|
||||
sudo apt-get install git -y
|
||||
```
|
||||
|
||||
## **❗ Notes:**
|
||||
* **Step 2:** \
|
||||
Once git is installed, use the following command to download KIAUH into your home-directoy:
|
||||
|
||||
**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
|
||||
```shell
|
||||
cd ~ && git clone https://github.com/th33xitus/kiauh.git
|
||||
```
|
||||
|
||||
- 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.
|
||||
* **Step 3:** \
|
||||
Finally start KIAUH by running the next command:
|
||||
|
||||
## **🌐 Sources & Further Information**
|
||||
```shell
|
||||
./kiauh/kiauh.sh
|
||||
```
|
||||
|
||||
* **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.
|
||||
|
||||
<hr>
|
||||
|
||||
<h2 align="center">❗ Notes ❗</h2>
|
||||
|
||||
### **📋 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 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.
|
||||
|
||||
<hr>
|
||||
|
||||
<h2 align="center">🌐 Sources & Further Information</h2>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -117,8 +171,10 @@ git clone https://github.com/th33xitus/kiauh.git
|
||||
|
||||
</table>
|
||||
|
||||
## **Credits**
|
||||
<hr>
|
||||
|
||||
<h2 align="center">✨ Credits ✨</h2>
|
||||
|
||||
* 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!
|
||||
|
||||
BIN
resources/screenshots/rpi_imager1.png
Normal file
BIN
resources/screenshots/rpi_imager1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
BIN
resources/screenshots/rpi_imager2.png
Normal file
BIN
resources/screenshots/rpi_imager2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
Reference in New Issue
Block a user