From abd6f2d35ff03029033bac4c24ac59adeb245a65 Mon Sep 17 00:00:00 2001 From: Igor Pecovnik Date: Thu, 25 Dec 2025 10:39:14 +0100 Subject: [PATCH] docs: improve README and add Armbian Imager promotion - Restructure README for better scannability and information hierarchy - Add prominent Armbian Imager recommendation at the top - Improve Build Host Requirements organization (Hardware/OS/Software) - Simplify and clarify language throughout - Better resource link descriptions - Remove redundant "Download Prebuilt Images" section The README now better guides users to Armbian Imager while still providing clear information for those building from source. --- README.md | 92 +++++++++++++++++++++++++------------------------------ 1 file changed, 42 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index af5b86046..069fca715 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,19 @@ -

+

Armbian logo

-

+ -### Purpose of This Repository +## Purpose of This Repository -The **Armbian Linux Build Framework** creates minimal, efficient, and fully [customizable operating system images](https://docs.armbian.com/#key-features) based on **Debian** or **Ubuntu**. It is designed specifically for **low-resource single board computers (SBCs)** and other embedded devices. +The **Armbian Linux Build Framework** creates customizable OS images based on **Debian** or **Ubuntu** for **single-board computers (SBCs)** and embedded devices. -This toolchain compiles a custom **Linux kernel**, **bootloader**, and **root filesystem**, providing fine-grained control over: +It builds a complete Linux system including kernel, bootloader, and root filesystem, giving you control over versions, configuration, firmware, device trees, and system optimizations. -- Kernel versions and configuration -- Bootloader selection and customization -- Filesystem layout and compression -- Additional firmware, overlays, and device trees -- System optimizations for performance and size +The framework supports **native**, **cross**, and **containerized** builds for multiple architectures (`x86_64`, `aarch64`, `armhf`, `riscv64`) and is suitable for development, testing, production, or automation. -The framework supports **native**, **cross**, and **containerized** builds for multiple architectures (`x86_64`, `aarch64`, `armhf`, `riscv64`), and is suitable for development, testing, production deployment, or automation pipelines. +> **Looking for prebuilt images?** Use [Armbian Imager](https://github.com/armbian/imager/releases) — the easiest way to download and flash Armbian to your SD card or USB drive. Available for Linux, macOS, and Windows. -It ensures **consistency across devices** while remaining modular and extensible through a variety of configuration files, templates, and user patches. - -### Quick Start +## Quick Start ```bash git clone https://github.com/armbian/build @@ -27,59 +21,57 @@ cd build ./compile.sh ``` -### Resources +Build demonstration -[Documentation](https://docs.armbian.com/Developer-Guide_Overview/) • [Website](https://www.armbian.com) • [Blog](https://blog.armbian.com) • [Community Forums](https://forum.armbian.com) +## Build Host Requirements +### Hardware +- **RAM:** ≥8GB (less with `KERNEL_BTF=no`) +- **Disk:** ~50GB free space +- **Architecture:** x86_64, aarch64, or riscv64 +### Operating System +- **Native builds:** Armbian or Ubuntu 24.04 (Noble) +- **Containerized:** Any Docker-capable Linux +- **Windows:** WSL2 with Armbian/Ubuntu 24.04 -Armbian logo +### Software +- Superuser privileges (`sudo` or root) +- Up-to-date system (outdated Docker or other tools can cause failures) -### Build Host Requirements +## Resources -- **Supported Architectures:** `x86_64`, `aarch64`, `riscv64` -- **System:** VM, container, or bare-metal with: - - **≥ 8GB RAM** (less with `KERNEL_BTF=no`) - - **~50GB disk space** -- **Operating System:** - - Armbian / Ubuntu 24.04 (Noble) for native builds - - Any Docker-capable Linux for containerized setup -- **Windows:** Windows 10/11 with WSL2 running Armbian / Ubuntu 24.04 -- **Access:** Superuser rights (`sudo` or `root`) -- **Important:** Keep your system up-to-date — outdated tools (e.g., Docker) can cause issues. +- **[Documentation](https://docs.armbian.com/Developer-Guide_Overview/)** — Comprehensive guides for building, configuring, and customizing +- **[Website](https://www.armbian.com)** — News, features, and board information +- **[Blog](https://blog.armbian.com)** — Development updates and technical articles +- **[Forums](https://forum.armbian.com)** — Community support and discussions -### Download +## Contributing -Prebuilt Armbian OS Images: +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on reporting issues, submitting changes, and contributing code. -### Contribute +## Support -Learn how to report issues, suggest improvements, or submit code: [CONTRIBUTING.md](CONTRIBUTING.md) +### Community Forums +Get help from users and contributors on troubleshooting, configuration, and development. +👉 [forum.armbian.com](https://forum.armbian.com) -### Support +### Real-time Chat +Join discussions with developers and community members on Discord, IRC, or Matrix. +👉 [Community Chat](https://docs.armbian.com/Community_IRC/) -Armbian offers multiple support channels, depending on your needs: +### Paid Consultation +For commercial projects, guaranteed response times, or advanced needs, paid support is available from Armbian maintainers. +👉 [Contact us](https://www.armbian.com/contact) -- **Community Forums** - Get help from fellow users and contributors on a wide range of topics — from troubleshooting to development. - 👉 [forum.armbian.com](https://forum.armbian.com) +## Contributors -- **Discord / IRC/ Matrix Chat** - Join real-time discussions with developers and community members for faster feedback and collaboration. - 👉 [Community Chat](https://docs.armbian.com/Community_IRC/) - -- **Paid Consultation** - For advanced needs, commercial projects, or guaranteed response times, paid support is available directly from Armbian maintainers. - 👉 [Contact us](https://www.armbian.com/contact) to discuss consulting options. - -### Contributors - -Thank you to all the people who already contributed to Armbian! +Thank you to everyone who has contributed to Armbian! - + Contributors ## Armbian Partners -Armbian's [partnership program](https://forum.armbian.com/subscriptions) helps to support Armbian and the Armbian community! Please take a moment to familiarize yourself with [our Partners](https://armbian.com/partners). +Our [partnership program](https://forum.armbian.com/subscriptions) supports Armbian's development and community. Learn more about [our Partners](https://armbian.com/partners).