Add README

This commit is contained in:
Laborratte 5 2026-03-26 13:56:50 +01:00
parent e0abf093b1
commit 84a54391b7
Signed by: Laborratte5
GPG key ID: 3A30072E35202C02

21
README.md Normal file
View file

@ -0,0 +1,21 @@
This project aims to simplify the provision of [Raspbian](https://www.raspberrypi.com/software/operating-systems/)
on the raspberry pi.
# How exactly does this project help?
This command liune tool does a view things:
1. It decompresses the `.xz` compressed image file
2. It flashes the image onto an sd-card
3. It resizes the main filesystem to the whole sd card size
4. It sets the cloud-init configuration for:
1. Network provisioning (setting a static IP-Address so one does not have to look into the router to get the assigned IP-Address)
2. User provisioning (creates a user and sets the allowed ssh key so it is easy to login in headless mode)
# Why not Raspberry Pi Imager
The [Raspberry Pi Imager](https://www.raspberrypi.com/documentation/computers/getting-started.html#raspberry-pi-imager)
also allows you to provision the flashed Raspbian image.
However currently the Pi-Imager does not directly work under wayland and needs some environment variables to be set.
Moreover, it is not possible to run the Pi Imager without root permissions, the problem with this is that the Pi Imager
still has a GUI and running GUI applications a root does not _feel_ right (at least in my opinion).