Files
ChillcraftOS/README.md
2025-04-22 18:29:27 -07:00

37 lines
1.6 KiB
Markdown

# ChillcraftOS Build System
ChillcraftOS is a custom Raspberry Pi OS built using a system based on `pi-gen`. This build system is specifically designed to create **ChillcraftOS** images, not general Raspberry Pi OS images.
**Important Notes:**
- The 32-bit versions of ChillcraftOS are based on Raspbian.
- The 64-bit versions of ChillcraftOS are based on Debian.
## Dependencies
The ChillcraftOS Build System relies on `pi-gen` and is compatible with Debian-based operating systems released after 2017. We recommend using the latest OS versions for better security.
For other Linux distributions, you can use the Docker-based build method provided below.
To install the required dependencies for building ChillcraftOS, run the following command:
```bash
apt-get install coreutils quilt parted qemu-user-static debootstrap zerofree zip \
dosfstools libarchive-tools libcap2-bin grep rsync xz-utils file git curl bc \
gpg pigz xxd arch-test
```
The `depends` file in the repository lists all the necessary tools, formatted as `<tool>[:<debian-package>]`.
## Getting Started with Building ChillcraftOS
To start building ChillcraftOS, clone the ChillcraftOS Build System repository:
```bash
git clone https://git.oxmc.me/Chillcraft/ChillcraftOS.git
```
For a shallow clone containing only the latest revision, you can add `--depth 1`. **However, avoid using this on your development machine**.
Make sure the repository is cloned to a directory **without spaces**, as spaces in the base path may cause `pi-gen` to fail.
Once cloned, you're ready to configure and start building ChillcraftOS.