build

<h2 align="center">
  <a href=#><img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logosmall.png" alt="Armbian logo"></a>
  <br><br>
</h2>

# Armbian Linux Build Framework

## Purpose of This Repository

The **Armbian Linux Build Framework** builds customizable OS images based on **Debian** or **Ubuntu** for **single-board computers (SBCs)** and other embedded devices. It assembles the kernel, bootloader, firmware, device trees and root filesystem into a reproducible image, with per-board and per-family configuration.

> **Looking for prebuilt images?** Use [Armbian Imager](https://github.com/armbian/imager/releases) — the easiest way to download and flash Armbian to an SD card or USB drive. Available for Linux, macOS and Windows.

## Quick Start

```bash
git clone https://github.com/armbian/build
cd build
./compile.sh
```

<a href="#armbian-linux-build-framework"><img src=".github/README.gif" alt="Build demonstration" width="100%"></a>

The entrypoint `compile.sh` sources `lib/single.sh` and dispatches into the framework in `lib/`. Build-time options can be passed on the command line, e.g.:

```bash
./compile.sh BOARD=orangepi5 BRANCH=current RELEASE=trixie BUILD_MINIMAL=yes KERNEL_CONFIGURE=no
```

## Build Host Requirements

### Hardware

- **RAM:** ≥ 8 GB (less with `KERNEL_BTF=no`)
- **Disk:** ~50 GB free space
- **Architecture:** x86_64, aarch64 or riscv64

### Operating System

- **Native builds:** Armbian / Debian 13 (Trixie)
- **Containerized:** any Docker-capable Linux
- **Windows:** WSL2 with Armbian / Debian 13 (Trixie)

### Software

- Superuser privileges (`sudo` or root)
- An up-to-date host (outdated Docker or other tooling can cause failures)

## Repository Layout

| Path | Contents |
|:--|:--|
| `compile.sh` | Build entrypoint; sources `lib/single.sh` and invokes the CLI |
| `lib/` | Core build framework (Bash functions, Python helpers under `lib/tools/`) |
| `config/` | Board, family, distribution, kernel and CLI configuration |
| `config/boards/` | One file per board; the extension marks its support status (see below) |
| `config/distributions/` | Supported Debian/Ubuntu release metadata |
| `config/cli/` | CLI package selections per release |
| `config/its/` | Image Tree Source files for device tree builder |
| `patch/` | Kernel, U-Boot and ATF patch sets organized by family/version |
| `packages/` | In-tree package sources, blobs and BSP material |
| `extensions/` | Optional build extensions enabled via `ENABLE_EXTENSIONS=` |
| `tools/` | Developer helpers (`mk_format_patch`, `unifying_configs`) |
| `action.yml` | GitHub Action definition ("Rebuild Armbian") |

### Board config extensions

Files under `config/boards/` use an extension that signals support status:

| Extension | Meaning |
|:--|:--|
| `.conf` | Standard board configuration |
| `.csc` | Community maintained / unstable (no active Armbian maintainer) |
| `.wip` | Work in progress |
| `.eos` | End of life |
| `.tvb` | TV box, community supp