mirror of
https://github.com/armbian/build
synced 2025-09-24 19:47:06 +07:00
Fixes to build train and small changes to README (#3433)
- set proper badge for building - adjust title: build tools -> build framework - keeping text relevance - add / remove partner logos
This commit is contained in:
2
.github/workflows/build-train.yml
vendored
2
.github/workflows/build-train.yml
vendored
@@ -376,7 +376,7 @@ jobs:
|
|||||||
|
|
||||||
Torrents:
|
Torrents:
|
||||||
name: Torrents
|
name: Torrents
|
||||||
needs: [x86-images,cli-images,desktop-images]
|
needs: [x86-cli-images,x86-desktop-images,cli-images,desktop-images]
|
||||||
if: ${{ github.repository_owner == 'Armbian' }}
|
if: ${{ github.repository_owner == 'Armbian' }}
|
||||||
uses: armbian/scripts/.github/workflows/update-download.yml@master
|
uses: armbian/scripts/.github/workflows/update-download.yml@master
|
||||||
|
|
||||||
|
|||||||
40
README.md
40
README.md
@@ -1,10 +1,10 @@
|
|||||||
<h3 align=center><a href="#build-tools"><img src=".github/armbian-logo.png" alt="Armbian logo" width="144"></a><br>
|
<h3 align=center><a href="#build-framework"><img src=".github/armbian-logo.png" alt="Armbian logo" width="144"></a><br>
|
||||||
build tools</h3>
|
build framework</h3>
|
||||||
|
|
||||||
<p align=right> </p>
|
<p align=right> </p>
|
||||||
|
|
||||||
[](https://github.com/armbian/build/commits)
|
[](https://github.com/armbian/build/commits)
|
||||||
[](https://github.com/armbian/build/actions/workflows/build-kernel-on-merge-request.yml)
|
[](https://github.com/armbian/build/actions/workflows/build-train.yml)
|
||||||
[](https://twitter.com/intent/follow?screen_name=armbian)
|
[](https://twitter.com/intent/follow?screen_name=armbian)
|
||||||
[](https://liberapay.com/armbian)
|
[](https://liberapay.com/armbian)
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ build tools</h3>
|
|||||||
- [Compare with industry standards](#compare-with-industry-standards)
|
- [Compare with industry standards](#compare-with-industry-standards)
|
||||||
- [Where to download prebuilt images?](#where-to-download-prebuilt-images)
|
- [Where to download prebuilt images?](#where-to-download-prebuilt-images)
|
||||||
- [Additional information](#additional-information)
|
- [Additional information](#additional-information)
|
||||||
- [Build tools overview](#build-tools-overview)
|
- [Build framework overview](#build-framework-overview)
|
||||||
- [Support](#support)
|
- [Support](#support)
|
||||||
- [Contribute](#contribute)
|
- [Contribute](#contribute)
|
||||||
- [Social](#social)
|
- [Social](#social)
|
||||||
@@ -29,22 +29,18 @@ build tools</h3>
|
|||||||
|
|
||||||
## What this project does?
|
## What this project does?
|
||||||
|
|
||||||
- builds custom Debian based Linux system optimized for [supported single board computers](https://www.armbian.com/download/),
|
- builds custom Linux optimized for [single board computers](https://www.armbian.com/download/),
|
||||||
- covers root filesystem generation, kernel image compilation and bootloader compilation,
|
- covers filesystem generation, low-level control software, kernel image compilation and bootloader compilation,
|
||||||
- maintains low-level control software for a [selection of hardware](https://www.armbian.com/download/),
|
- provides a consistent user experience by keeping system standards across different platforms.
|
||||||
- provides a consistent user experience by keeping system standards across different SBC platforms.
|
|
||||||
|
|
||||||
<p align=right> </p>
|
<p align=right> </p>
|
||||||
|
|
||||||
## What do you need to get started?
|
## What do you need to get started?
|
||||||
|
|
||||||
- x64 machine with at least 2GB of memory and ~35GB of disk space for a VM, container or native OS,
|
- x64 / aarch64 machine with at least 2GB of memory and ~35GB of disk space for a VM, container or native OS,
|
||||||
- Ubuntu Hirsute 21.04 x64 for native building or any [Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) capable x64 Linux for containerised,
|
- Ubuntu Hirsute 21.04 x64 / aarch64 for native building or any [Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) capable x64 / aarch64 Linux for containerised,
|
||||||
- Hirsute is required for newer non-LTS releases.. ex: Bullseye, Sid, Groovy, Hirsute
|
|
||||||
- If building for LTS releases.. ex: Focal, Bionic, Buster, it is possible to use Ubuntu 20.04 Focal, but it is not supported
|
|
||||||
- superuser rights (configured sudo or root access).
|
- superuser rights (configured sudo or root access).
|
||||||
|
|
||||||
|
|
||||||
<p align=right><a href=#table-of-contents>⇧</a></p>
|
<p align=right><a href=#table-of-contents>⇧</a></p>
|
||||||
|
|
||||||
## How to build an image or a kernel?
|
## How to build an image or a kernel?
|
||||||
@@ -56,8 +52,8 @@ cd build
|
|||||||
./compile.sh
|
./compile.sh
|
||||||
```
|
```
|
||||||
<a href="#how-to-build-an-image-or-a-kernel"><img src=".github/README.gif" alt="Armbian logo" width="100%"></a>
|
<a href="#how-to-build-an-image-or-a-kernel"><img src=".github/README.gif" alt="Armbian logo" width="100%"></a>
|
||||||
- The script will take care about preparing the workspace like installing necessary dependencies and downloading sources and tools
|
- will prepare the workspace by installing necessary dependencies and sources
|
||||||
- It guides through the process until either a kernel package set or a ready-to-use image for a SDcard is created
|
- it guides through the process until either a kernel package set or a ready-to-use image for a SDcard is created
|
||||||
|
|
||||||
<p align=right><a href=#table-of-contents>⇧</a></p>
|
<p align=right><a href=#table-of-contents>⇧</a></p>
|
||||||
|
|
||||||
@@ -69,7 +65,7 @@ Show work in progress areas in interactive mode:
|
|||||||
./compile.sh EXPERT="yes"
|
./compile.sh EXPERT="yes"
|
||||||
```
|
```
|
||||||
|
|
||||||
Run build tools inside Docker container:
|
Run build framework inside Docker container:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
./compile.sh docker
|
./compile.sh docker
|
||||||
@@ -133,7 +129,7 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the
|
|||||||
|
|
||||||
<p align=right><a href=#table-of-contents>⇧</a></p>
|
<p align=right><a href=#table-of-contents>⇧</a></p>
|
||||||
|
|
||||||
## Build tools overview
|
## Build framework overview
|
||||||
|
|
||||||
```text
|
```text
|
||||||
├── cache Work / cache directory
|
├── cache Work / cache directory
|
||||||
@@ -152,7 +148,7 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the
|
|||||||
│ ├── sources Kernel and u-boot sources locations and scripts
|
│ ├── sources Kernel and u-boot sources locations and scripts
|
||||||
│ ├── templates User configuration templates which populate userpatches
|
│ ├── templates User configuration templates which populate userpatches
|
||||||
│ └── torrents External compiler and rootfs cache torrents
|
│ └── torrents External compiler and rootfs cache torrents
|
||||||
├── lib Main build tools libraries
|
├── lib Main build framework libraries
|
||||||
├── output Build artifact
|
├── output Build artifact
|
||||||
│ └── deb Deb packages
|
│ └── deb Deb packages
|
||||||
│ └── images Bootable images - RAW or compressed
|
│ └── images Bootable images - RAW or compressed
|
||||||
@@ -174,7 +170,7 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the
|
|||||||
| ├── u-boot-board For specific board
|
| ├── u-boot-board For specific board
|
||||||
| └── u-boot-family For entire kernel family
|
| └── u-boot-family For entire kernel family
|
||||||
└── userpatches User: configuration patching area
|
└── userpatches User: configuration patching area
|
||||||
├── lib.config User: tools common config/override file
|
├── lib.config User: framework common config/override file
|
||||||
├── config-default.conf User: default user config file
|
├── config-default.conf User: default user config file
|
||||||
├── customize-image.sh User: script will execute just before closing the image
|
├── customize-image.sh User: script will execute just before closing the image
|
||||||
├── atf User: ARM trusted firmware
|
├── atf User: ARM trusted firmware
|
||||||
@@ -187,9 +183,9 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the
|
|||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
- Have you found a bug in the **build tools**?
|
- Have you found a bug in the **build framework**?
|
||||||
|
|
||||||
Try to recreate it with a clean build tools clone. Then search for [existing and closed issues](https://github.com/armbian/build/issues). If you don't find it there, [open a new issue](https://github.com/armbian/build/issues/new).
|
Try to recreate it with a clean build framework clone. Then search for [existing and closed issues](https://github.com/armbian/build/issues). If you don't find it there, [open a new issue](https://github.com/armbian/build/issues/new).
|
||||||
|
|
||||||
- Do you have troubles **elsewhere**?
|
- Do you have troubles **elsewhere**?
|
||||||
|
|
||||||
@@ -239,5 +235,5 @@ Most of the project is sponsored with a work done by volunteer collaborators, wh
|
|||||||
|
|
||||||
[Do you want to see yourself below?](https://www.armbian.com/#contact)
|
[Do you want to see yourself below?](https://www.armbian.com/#contact)
|
||||||
|
|
||||||
<a href="https://www.armbian.com/download/?tx_maker=xunlong" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/03/orangepi-logo-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=friendlyelec" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/02/friendlyelec-logo-150x150.png" width="122" height="122"></a><a href="https://k-space.ee" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/03/kspace-150x150.png" width="122" height="122"></a><a href="https://www.innoscale.net" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/07/innoscale-2-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=olimex" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/02/olimex-logo-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=kobol" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/06/Kobol_logo-150x150.png" width="122" height="122"></a><a href="https://github.com/WorksOnArm/cluster/issues/223" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/11/work-on-arm-150x150.png" width="122" height="122"></a><a href="https://fosshost.org/" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/11/foss-host-150x150.png" width="122" height="122"></a>
|
<a href="https://www.armbian.com/download/?tx_maker=xunlong" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/03/orangepi-logo-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=friendlyelec" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/02/friendlyelec-logo-150x150.png" width="122" height="122"></a><a href="https://k-space.ee" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/03/kspace-150x150.png" width="122" height="122"></a><a href="https://www.innoscale.net" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/07/innoscale-2-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=olimex" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2018/02/olimex-logo-150x150.png" width="122" height="122"></a><a href="https://www.armbian.com/download/?tx_maker=kobol" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/06/Kobol_logo-150x150.png" width="122" height="122"></a><a href="https://github.com/WorksOnArm/cluster/issues/223" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/11/work-on-arm-150x150.png" width="122" height="122"></a><a href="https://fosshost.org/" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2020/11/foss-host-150x150.png" width="122" height="122"></a><a href="https://nlnet.nl/" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2022/01/nlnet-fundation-150x150.png" width="122" height="122"></a><a href="#"><img border=0 src="https://www.armbian.com/wp-content/uploads/2021/06/lanecloud-150x150.png" width="122" height="122"></a><a href="https://www.khadas.com/" target="_blank"><img border=0 src="https://www.armbian.com/wp-content/uploads/2021/05/khadas-150x150.png" width="122" height="122"></a>
|
||||||
<p align=right><a href=#table-of-contents>⇧</a></p>
|
<p align=right><a href=#table-of-contents>⇧</a></p>
|
||||||
|
|||||||
Reference in New Issue
Block a user