basementhud/README.md

33 lines
792 B
Markdown

# Basement Hud Network-Booted OS
Customized Fedora-based operating system distributed as an immutable
root filesystem image.
## Building
Must run on a Fedora host or privileged container.
Build the root filesystem image:
```sh
make rootfs
```
This will create an `_build/rootfs` directory containing the root filesystem
hierarchy. The `_build/rootfs/boot` directory contains the necessary files to
boot the system:
* `efi`: This directory contains the Raspberry Pi firmware files
* `initramfs.img`: Early userspace image
* `vmlinuz`: Kernel image
* `basementhud.squashfs`: Root filesystem image
The Raspberry Pi firmware, initramfs image, and kernel image files must be
served by a TFTP, while the rootfs image is served by NBD.
Build the initramfs image:
```sh
make initramfs
```