From 249c20c7e2d6fa80e40d639213566fce2350f472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20Pe=C4=8Dovnik?= Date: Mon, 24 Jan 2022 17:11:38 +0100 Subject: [PATCH] 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 --- .github/workflows/build-train.yml | 2 +- README.md | 40 ++++++++++++++----------------- 2 files changed, 19 insertions(+), 23 deletions(-) diff --git a/.github/workflows/build-train.yml b/.github/workflows/build-train.yml index 4d3ff9249..1afd6211d 100644 --- a/.github/workflows/build-train.yml +++ b/.github/workflows/build-train.yml @@ -376,7 +376,7 @@ jobs: 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' }} uses: armbian/scripts/.github/workflows/update-download.yml@master diff --git a/README.md b/README.md index 003c75736..60f6cd74e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -

Armbian logo
-build tools

+

Armbian logo
+build framework

 

[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/armbian/build/master)](https://github.com/armbian/build/commits) -[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/armbian/build/Build)](https://github.com/armbian/build/actions/workflows/build-kernel-on-merge-request.yml) +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/armbian/build/Build?label=build%20train)](https://github.com/armbian/build/actions/workflows/build-train.yml) [![Twitter Follow](https://img.shields.io/twitter/follow/armbian?style=flat-square)](https://twitter.com/intent/follow?screen_name=armbian) [![Become a patron](https://img.shields.io/liberapay/patrons/armbian.svg?logo=liberapay)](https://liberapay.com/armbian) @@ -17,7 +17,7 @@ build tools - [Compare with industry standards](#compare-with-industry-standards) - [Where to download prebuilt images?](#where-to-download-prebuilt-images) - [Additional information](#additional-information) -- [Build tools overview](#build-tools-overview) +- [Build framework overview](#build-framework-overview) - [Support](#support) - [Contribute](#contribute) - [Social](#social) @@ -29,22 +29,18 @@ build tools ## What this project does? -- builds custom Debian based Linux system optimized for [supported single board computers](https://www.armbian.com/download/), -- covers root filesystem generation, 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 SBC platforms. +- builds custom Linux optimized for [single board computers](https://www.armbian.com/download/), +- covers filesystem generation, low-level control software, kernel image compilation and bootloader compilation, +- provides a consistent user experience by keeping system standards across different platforms.

 

## 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, -- 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, - - 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 +- 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 / aarch64 for native building or any [Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) capable x64 / aarch64 Linux for containerised, - superuser rights (configured sudo or root access). -

⇧

## How to build an image or a kernel? @@ -56,8 +52,8 @@ cd build ./compile.sh ``` Armbian logo -- The script will take care about preparing the workspace like installing necessary dependencies and downloading sources and tools -- It guides through the process until either a kernel package set or a ready-to-use image for a SDcard is created +- 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

⇧

@@ -69,7 +65,7 @@ Show work in progress areas in interactive mode: ./compile.sh EXPERT="yes" ``` -Run build tools inside Docker container: +Run build framework inside Docker container: ```text ./compile.sh docker @@ -133,7 +129,7 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the

⇧

-## Build tools overview +## Build framework overview ```text ├── 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 │   ├── templates User configuration templates which populate userpatches │   └── torrents External compiler and rootfs cache torrents -├── lib Main build tools libraries +├── lib Main build framework libraries ├── output Build artifact │   └── deb Deb packages │   └── 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-family For entire kernel family └── 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 ├── customize-image.sh User: script will execute just before closing the image    ├── atf User: ARM trusted firmware @@ -187,9 +183,9 @@ Armbian [releases](https://docs.armbian.com/Release_Changelog/) quarterly at the ## 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**? @@ -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) - +

⇧