mirror of
https://github.com/dw-0/kiauh.git
synced 2025-12-11 17:44:28 +05:00
docs: add Raspberry Pi setup guide and update installation instructions
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
This commit is contained in:
BIN
docs/assets/rpi_imager1.png
Normal file
BIN
docs/assets/rpi_imager1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
BIN
docs/assets/rpi_imager2.png
Normal file
BIN
docs/assets/rpi_imager2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
@@ -0,0 +1 @@
|
||||
# Community Extensions
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
!!! tip "Important"
|
||||
This documentation is for KIAUH version 6 and still work in progress!
|
||||
|
||||
<h1 align="center">
|
||||
KIAUH - Klipper Installation And Update Helper
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/logo-large.png" alt="KIAUH logo">
|
||||
<img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
|
||||
</p>
|
||||
<p align="center">
|
||||
<p align="center" style="font-size: 1.2em; font-weight: bold;">
|
||||
A handy installation script that makes installing Klipper (and more) a breeze!
|
||||
</p>
|
||||
|
||||
|
||||
39
docs/setup/installation.md
Normal file
39
docs/setup/installation.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Installing KIAUH
|
||||
|
||||
In the following sections, you will be guided through the installation
|
||||
process step-by-step.
|
||||
|
||||
To use KIAUH, it is enough to download the script and run it on your
|
||||
Raspberry Pi or other compatible device. If you need to know how to
|
||||
set up a Raspberry Pi or if you are unsure whether your current setup
|
||||
is sufficient, please refer to the [Raspberry Pi Installation Guide](raspberry-pi-setup.md)
|
||||
and follow the steps therein. Afterwards, you can return to this guide to install KIAUH.
|
||||
|
||||
### Prerequisites
|
||||
Before you can download and run KIAUH, you need to ensure that ``git`` is
|
||||
installed on your system. Open a terminal and run the following command:
|
||||
|
||||
```bash
|
||||
sudo apt-get update && sudo apt-get install git -y
|
||||
```
|
||||
|
||||
### Downloading KIAUH
|
||||
After `git` was successfully installed, you can download KIAUH by
|
||||
cloning the repository from GitHub. It is recommended to clone it into
|
||||
your home directory. Run the following command in your terminal:
|
||||
```bash
|
||||
cd ~ && git clone https://github.com/dw-0/kiauh.git
|
||||
```
|
||||
|
||||
### Running KIAUH
|
||||
Once the repository is cloned, you can start KIAUH. Make sure you are in
|
||||
your home directory and execute the script by running the following
|
||||
command:
|
||||
```bash
|
||||
./kiauh/kiauh.sh
|
||||
```
|
||||
|
||||
After executing the command, you will be presented with the KIAUH menu,
|
||||
which allows you to install and manage various 3D printing software.
|
||||
For more information on how to use KIAUH, please refer to the
|
||||
[Usage Guide](usage.md).
|
||||
49
docs/setup/raspberry-pi-setup.md
Normal file
49
docs/setup/raspberry-pi-setup.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Raspberry Pi Setup
|
||||
|
||||
This guide will help you set up a Raspberry Pi for running Klipper and other,
|
||||
Klipper related 3D printing software. In case you are using a different single-board
|
||||
computer (SBC), please refer to the manufacturer's instructions for installing
|
||||
a compatible version of Linux on your device.
|
||||
|
||||
It is assumed that you have at least a Raspberry Pi 3 or newer, along with a
|
||||
microSD card (at least 8GB, preferably 16GB or more) and a power supply.
|
||||
Additionally, you will need a computer with an SD card reader to prepare
|
||||
the microSD card.
|
||||
|
||||
KIAUH requires a Linux operating system that has already been flashed to your
|
||||
Raspberry Pi's (or other SBC's) microSD card. As a result, you must ensure that you
|
||||
already have a functional Linux system on hand before you can proceed with
|
||||
installing KIAUH. `Raspberry Pi OS Lite` (either 32bit or 64bit) is a recommended Linux image
|
||||
if you are using a Raspberry Pi.
|
||||
|
||||
---
|
||||
|
||||
To flash `Raspberry Pi OS Lite` to your microSD card using the official [Raspberry Pi Imager](https://www.raspberrypi.com/software/),
|
||||
follow the steps below. If you encounter any issues or need further assistance, please refer to the [official Raspberry Pi documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
|
||||
|
||||
1. Open the Raspberry Pi Imager application on your computer.
|
||||
2. Click on `Choose OS` and select `Raspberry Pi OS (other)`.
|
||||

|
||||
3. Choose `Raspberry Pi OS Lite (32bit)` (or 64bit if desired).
|
||||

|
||||
4. Insert the microSD card into your computer's SD card reader.
|
||||
5. In the main menu of the Imager, select the correct microSD card.
|
||||
6. Click the gear icon at the bottom left of the main menu to open advanced options.
|
||||
7. Enable SSH and enter your Wi-Fi credentials.
|
||||
|
||||
!!! info
|
||||
Wi-Fi is only necessary if you want to connect to your Raspberry Pi over a wireless network. If you plan to use a wired Ethernet connection, you can skip this step. SSH is required for remote access to your Raspberry Pi, so make sure to enable it.
|
||||
|
||||
8. Click `Save` to close the advanced options menu.
|
||||
9. Click `Write` to start flashing the image to the microSD card.
|
||||
|
||||
!!! warning
|
||||
All data on the microSD card will be overwritten!
|
||||
|
||||
10. Once the flashing process is complete, safely eject the microSD card from your computer.
|
||||
11. Insert the microSD card into your Raspberry Pi.
|
||||
12. Connect your Raspberry Pi to a power source to boot it up.
|
||||
13. Wait for a few minutes to allow the Raspberry Pi to complete its initial setup.
|
||||
14. You can now connect to your Raspberry Pi via SSH using the IP address assigned by your router. The default username is `pi` and the default password is `raspberry`.
|
||||
|
||||
If you successfully connected to your Raspberry Pi via SSH, you can proceed to install KIAUH by following the instructions in the [Installation Guide](installation.md).
|
||||
@@ -63,7 +63,9 @@ markdown_extensions:
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Installation: installation.md
|
||||
- Installation:
|
||||
- setup/raspberry-pi-setup.md
|
||||
- setup/installation.md
|
||||
- Configuration: configuration.md
|
||||
- Extensions:
|
||||
- extensions/index.md
|
||||
|
||||
Reference in New Issue
Block a user