Armbian Linux build framework generates custom Debian or Ubuntu

# DEPRECATED: # This branch will not receive any further updates or fixes. Do NOT open bug reports when using it. <p align="center"> <a href="#build-framework"> <img src=".github/armbian-logo.png" alt="Armbian logo" width="144"> </a><br> <strong>Armbian Linux Build Framework</strong><br> <br> <a href=https://github.com/armbian/build/actions/workflows/build-train.yml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/build/build-train.yml?logo=githubactions&label=Kernel%20compile&logoColor=white&style=for-the-badge&branch=master"></a> <a href=https://github.com/armbian/build/actions/workflows/build-all-desktops.yml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/build/build-all-desktops.yml?logo=githubactions&logoColor=white&label=Images%20assembly&style=for-the-badge&branch=master"></a> <a href=https://github.com/armbian/build/actions/workflows/smoke-tests.yml><img alt="Smoke test success ratio" src="https://img.shields.io/badge/dynamic/json?logo=speedtest&label=Smoke%20tests%20success&query=SMOKE&color=44cc11&cacheSeconds=600&style=for-the-badge&url=https%3A%2F%2Fgithub.com%2Farmbian%2Fscripts%2Freleases%2Fdownload%2Fstatus%2Frunners_capacity.json"></a> <br> <br> <a href=https://fosstodon.org/@armbian><img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/109365956768424870?domain=https%3A%2F%2Ffosstodon.org&logo=mastodon&style=flat-square"></a> <a href=http://discord.armbian.com/><img alt="Discord" src="https://img.shields.io/discord/854735915313659944?label=Discord&logo=discord&style=flat-square"></a> <a href=https://liberapay.com/armbian><img alt="Liberapay patrons" src="https://img.shields.io/liberapay/patrons/armbian?logo=liberapay&style=flat-square"></a> </p> ## Table of contents - [What this project does?](#what-this-project-does) - [Getting started](#getting-started) - [Compare with industry standards](#compare-with-industry-standards) - [Download prebuilt images](#download-prebuilt-images) - [Project structure](#project-structure) - [Contribution](#contribution) - [Support](#support) - [Contact](#contact) - [Contributors](#contributors) - [Sponsors](#sponsors) - [License](#license) ## What this project does? - Builds custom kernel, image or a distribution optimized for low resource HW such as single board computers, - Include filesystem generation, low-level control software, kernel image and bootloader compilation, - Provides a consistent user experience by keeping system standards across different platforms. ## Getting started ### Basic requirements - x86_64 or aarch64 machine with at least 2GB of memory and ~35GB of disk space for a virtual machine, container or bare metal installation - Ubuntu Jammy 22.04.x amd64 or aarch64 for native building or any [Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) capable amd64 / aarch64 Linux for containerised - Superuser rights (configured sudo or root access). ### Simply start with the build script ```bash apt-get -y install git git clone --depth=1 --branch=master https://github.com/armbian/build cd build ./compile.sh ``` <a href="#how-to-build-an-image-or-a-kernel"><img src=".github/README.gif" alt="Armbian logo" width="100%"></a> - Interactive graphical interface. - The workspace will be prepared by installing the necessary dependencies and sources. - It guides the entire process until a kernel package or ready-to-use image of the SD card is created. ### Build parameter examples Show work in progress areas in interactive mode: ```bash ./compile.sh EXPERT="yes" ``` Run build framework inside Docker container: ```bash ./compile.sh docker ``` Build minimal CLI Armbian Focal image for Orangepi Zero. Use modern kernel and write image to the SD card: ```bash ./compile.sh \ BOARD=orangepizero \ BRANCH=current \ RELEASE=focal \ BUILD_MINIMAL=yes \ BUILD_DESKTOP=no \ KERNEL_ONLY=no \ KERNEL_CONFIGURE=no \ CARD_DEVICE="/dev/sdX" ``` More information: - [Building Armbian](https://docs.armbian.com/Developer-Guide_Build-Preparation/) — how to start, how to automate; - [Build options](https://docs.armbian.com/Developer-Guide_Build-Options/) — all build options; - [Building with Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) — how to build inside container; - [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) — how to add packages, patches and override sources config; ## Download prebuilt images - quarterly released **supported** builds — <https://www.armbian.com/download> - weekly released **unsupported** community builds — <https://github.com/armbian/community> - upon code change **unsupported** development builds — <https://github.com/armbian/build/releases> ## Compare with industry standards Check similarity, advantages and disadvantages compared with leading industry standard build software. Function | Armbian | Yocto | Buildroot | |:--|:--|:--|:--| | Target | general purpose | embedded | embedded / IOT | | U-boot and kernel | compiled from sources | compiled from sources | compiled from sources | | Board support maintenance &nbsp; | complete | outside | outside | | Root file system | Debian or Ubuntu based| custom | custom | | Package manager | APT | any | none | | Configurability | limited | large | large | | Initramfs support | yes | yes | yes | | Getting started | quick | very slow | slow | | Cross compilation | yes | yes | yes | ## Project structure ```text ├── cache Work / cache directory │   ├── rootfs Compressed userspace packages cache │   ├── sources Kernel, u-boot and various drivers sources. │   ├── toolchains External cross compilers from Linaro™ or ARM™ ├── config Packages repository configurations │   ├── targets.conf Board build target configuration │   ├── boards Board configurations │   ├── bootenv Initial boot loaders environments per family │   ├── bootscripts Initial Boot loaders scripts per family │   ├── cli CLI packages configurations per distribution │   ├── desktop Desktop packages configurations per distribution │   ├── distributions Distributions settings │   ├── kernel Kernel build configurations per family │   ├── sources Kernel and u-boot sources locations and scripts │   ├── templates User configuration templates which populate userpatches │   └── torrents External compiler and rootfs cache torrents ├── extensions extend build system with specific functionality ├── lib Main build framework libraries ├── output Build artifact │   └── deb Deb packages │   └── images Bootable images - RAW or compressed │   └── debug Patch and build logs │   └── config Kernel configuration export location │   └── patch Created patches location ├── packages Support scripts, binary blobs, packages │   ├── blobs Wallpapers, various configs, closed source bootloaders │   ├── bsp-cli Automatically added to armbian-bsp-cli package │   ├── bsp-desktop Automatically added to armbian-bs