Skip to content

Commit

Permalink
Improve framework welcome page, clean getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpecovnik committed Nov 14, 2024
1 parent 2bf12bd commit b1b1539
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 27 deletions.
40 changes: 14 additions & 26 deletions docs/Developer-Guide_Build-Preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,25 @@

## Requirements

- x86_64 / aarch64 machine
- at least 2GB of memory and ~35GB of disk space for VM, container or bare metal installation
- Armbian / Ubuntu Jammy 22.04.x for native building or any Docker capable Linux for containerised
- Windows 10/11 with WSL2 subsystem running Armbian / Ubuntu Jammy 22.04.x
- x86_64 / aarch64 / riscv64 machine
- at least 4GB of memory and ~50GB of disk space for VM, container or bare metal installation
- **Armbian / Ubuntu Jammy 22.04.x** for native building or any Docker capable Linux for containerised
- **Windows 10/11 with WSL2 subsystem** running Armbian / Ubuntu Jammy 22.04.x
- Superuser rights (configured sudo or root access).
- Make sure your system is up-to-date! Outdated Docker binaries, for example, can cause trouble
- Install git (apt-get -y -qq install git)

!!! danger
Make sure that full path to the build script **does not contain spaces**.

Clone repository:
## Clone repository

```bash
git clone --depth=1 --branch=main https://github.com/armbian/build
git clone https://github.com/armbian/build
cd build
```
!!! note
- Make sure that full path to the build script **does not contain spaces**
- For stable branch use `--branch=v24.11`


## Interactive

Run framework:
Expand All @@ -27,23 +29,9 @@ Run framework:
./compile.sh
```

``` mermaid
graph LR
A[./compile.sh] --> B{Change<br>kernel<br>config};
B ---> |yes| C["HW"];
B ---> |no| C["HW"];
C ---> |branch| D["legacy<br>vendor<br>current<br>edge"];
D --> |base| E["Debian<br>Ubuntu"];
E ---> |type| F["CLI"];
F ---> |type| G["Server"];
F ---> |type| H["Minimal"];
E ---> I["Desktop"];
I ---> K["XFCE"];
I ---> L["Gnome"];
I ---> M["Cinammon"];
I ---> N["KDE Neon"];
```
Video instructions: <https://www.youtube.com/watch?v=kQcEFsXEJEE>
??? info "Video"
<iframe width="939" height="529" src="https://www.youtube.com/embed/kQcEFsXEJEE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>


## CLI

Expand Down
42 changes: 42 additions & 0 deletions docs/Developer-Guide_Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## What it does?

- Builds custom **kernel**, **image** or a Debian based Linux **distribution** optimized for low-resource hardware,
- Include filesystem generation, low-level control software, kernel image and **bootloader** compilation,
- Provides a **consistent user experience** by keeping system standards across different platforms.

``` mermaid
graph LR
A[./compile.sh] --> B{Change<br>kernel<br>config};
B ---> |yes| C["HW"];
B ---> |no| C["HW"];
C ---> |branch| D["legacy<br>vendor<br>current<br>edge"];
D --> |base| E["Debian<br>Ubuntu"];
E ---> |type| F["CLI"];
F ---> |type| G["Server"];
F ---> |type| H["Minimal"];
E ---> I["Desktop"];
I ---> K["XFCE"];
I ---> L["Gnome"];
I ---> M["Cinammon"];
I ---> N["KDE Neon"];
```

## Key Advantages

- Simplicity with interactive graphical interface.
- Generates widely recognized and well maintained userspace
- Fast learning curve for complex operations

Check other similarities, 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 |
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ nav:
- 'Netconfig': 'User-Guide_Armbian-Software/Netconfig.md'

- 'ARMBIAN BUILD FRAMEWORK' :
- 'Overview' : 'Developer-Guide_Welcome.md'
- 'Overview' : 'Developer-Guide_Overview.md'
- 'Getting Started' : 'Developer-Guide_Build-Preparation.md'
- 'Build Commands' : 'Developer-Guide_Build-Commands.md'
- 'Build Switches' : 'Developer-Guide_Build-Switches.md'
Expand Down

0 comments on commit b1b1539

Please sign in to comment.