mirror of
https://github.com/armbian/build
synced 2025-09-24 19:47:06 +07:00
Adjust text on main README.md (#6062)
This commit is contained in:
59
README.md
59
README.md
@@ -17,12 +17,14 @@
|
|||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
### Basic requirements
|
### Requirements
|
||||||
|
|
||||||
- x86_64 or aarch64 machine with at least 2GB of memory and ~35GB of disk space for a virtual machine, [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install), container or bare metal installation
|
- x86_64 / aarch64 machine
|
||||||
- Ubuntu Jammy 22.04.x amd64 or aarch64 for native building or any Docker capable amd64 / aarch64 Linux for containerised
|
- at least 2GB of memory and ~35GB of disk space for VM, container or bare metal installation
|
||||||
|
- Ubuntu Jammy 22.04.x for native building or any Docker capable Linux for containerised
|
||||||
|
- Windows 10/11 with WSL2 subsystem running Ubuntu Jammy 22.04.x
|
||||||
- Superuser rights (configured sudo or root access).
|
- Superuser rights (configured sudo or root access).
|
||||||
- Make sure all your system components are up-to-date. Outdated Docker binaries, for example, can cause trouble.
|
- Make sure your system is up-to-date! Outdated Docker binaries, for example, can cause trouble.
|
||||||
|
|
||||||
### Start with the build script
|
### Start with the build script
|
||||||
|
|
||||||
@@ -59,11 +61,11 @@ Show work-in-progress areas in interactive mode:
|
|||||||
./compile.sh EXPERT="yes"
|
./compile.sh EXPERT="yes"
|
||||||
```
|
```
|
||||||
|
|
||||||
Build minimal CLI Armbian Jammy image for Orangepi Zero. Use `current` kernel and write image to the SD card:
|
Build minimal CLI Armbian Jammy for Raspberry Pi 4B with LTS kernel and write image directly to the SD card:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./compile.sh \
|
./compile.sh \
|
||||||
BOARD=orangepizero \
|
BOARD=rpi4b \
|
||||||
BRANCH=current \
|
BRANCH=current \
|
||||||
RELEASE=jammy \
|
RELEASE=jammy \
|
||||||
BUILD_MINIMAL=yes \
|
BUILD_MINIMAL=yes \
|
||||||
@@ -74,15 +76,20 @@ CARD_DEVICE="/dev/sdX"
|
|||||||
|
|
||||||
More information:
|
More information:
|
||||||
|
|
||||||
- [Building Armbian](https://docs.armbian.com/Developer-Guide_Build-Preparation/) — how to start, how to automate;
|
- [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;
|
- [Build options](https://docs.armbian.com/Developer-Guide_Build-Options/) (all build options)
|
||||||
- [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) — how to add packages, patches, and override sources config;
|
- [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) (how to add packages, patches, and override sources config)
|
||||||
|
|
||||||
## Download prebuilt images
|
## Download prebuilt images releases
|
||||||
|
|
||||||
- [quarterly released **supported** builds](https://www.armbian.com/download/?device_support=Standard%20support)
|
### Point
|
||||||
- [quarterly released **community maintained** builds](https://www.armbian.com/download/?device_support=Community%20maintained)
|
|
||||||
- [automatic released **rolling release** builds](https://github.com/armbian/os/releases/latest) (daily or when code changes)
|
- [manually released **standard supported** builds](https://www.armbian.com/download/?device_support=Standard%20support) (quarterly)
|
||||||
|
|
||||||
|
### Rolling
|
||||||
|
|
||||||
|
- [automatically released **staging and standard supported** builds](https://github.com/armbian/os/releases/latest) (daily)
|
||||||
|
- [automatically released **community maintained** builds](https://github.com/armbian/community/releases/latest) (weekly)
|
||||||
|
|
||||||
## Compared with industry standards
|
## Compared with industry standards
|
||||||
|
|
||||||
@@ -182,25 +189,15 @@ Function | Armbian | Yocto | Buildroot |
|
|||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|
||||||
### You don't need to be a programmer to help!
|
### Want to help?
|
||||||
|
|
||||||
The easiest way to help is by "Starring" our repository - it helps more people find our code.
|
We always need those volunteering positions:
|
||||||
|
|
||||||
- [Check out our list of volunteer positions](https://forum.armbian.com/staffapplications/) and choose what you want to do ❤️
|
- [Code reviewer](https://forum.armbian.com/staffapplications/application/23-code-reviewer/)
|
||||||
- [Mirror our download infrastructure](https://github.com/armbian/mirror/) ❤️
|
- [Build framework maintainer](https://forum.armbian.com/staffapplications/application/9-build-framework-maintainer/)
|
||||||
- [Donate](https://www.armbian.com/donate)! ❤️
|
- [Test Automation Engineer](https://forum.armbian.com/staffapplications/application/19-test-automation-engineer/)
|
||||||
|
|
||||||
### Want to become a maintainer?
|
Just apply and follow!
|
||||||
|
|
||||||
Please review the [Board Maintainers Procedures and Guidelines](https://docs.armbian.com/Board_Maintainers_Procedures_and_Guidelines/) and [apply](https://forum.armbian.com/staffapplications/application/8-single-board-computer-maintainer/) !
|
|
||||||
|
|
||||||
### Want to become a developer?
|
|
||||||
|
|
||||||
To help with development, review [this document](CONTRIBUTING.md) and move straight to the code:
|
|
||||||
|
|
||||||
- [release related tickets](https://www.armbian.com/participate/)
|
|
||||||
- [review pull requests](https://github.com/armbian/build/pulls?q=is%3Apr+is%3Aopen+review%3Arequired+label%3A%22Needs+review%22)
|
|
||||||
- ticket dashboard for [junior](https://armbian.atlassian.net/jira/dashboards/10000) and [seniors](https://armbian.atlassian.net/jira/dashboards/10103) developers
|
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
@@ -216,9 +213,9 @@ Free support:
|
|||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
- [Forums](https://forum.armbian.com) for Participate in Armbian
|
- [Forums](https://forum.armbian.com) for Participate in Armbian
|
||||||
- IRC: `#armbian` on Libera.chat
|
- IRC: `#armbian` on Libera.chat / oftc.net
|
||||||
- Discord: [https://discord.gg/armbian](https://discord.gg/armbian)
|
- Discord: [https://discord.gg/armbian](https://discord.gg/armbian)
|
||||||
- Follow [@armbian](https://twitter.com/armbian) on X (formerly known as Twitter), [Fosstodon](https://fosstodon.org/@armbian) or [LinkedIn](https://www.linkedin.com/company/armbian).
|
- Follow [@armbian](https://twitter.com/armbian) on 𝕏 (formerly known as Twitter), [Fosstodon](https://fosstodon.org/@armbian) or [LinkedIn](https://www.linkedin.com/company/armbian).
|
||||||
- Bugs: [issues](https://github.com/armbian/build/issues) / [JIRA](https://armbian.atlassian.net/jira/dashboards/10000)
|
- Bugs: [issues](https://github.com/armbian/build/issues) / [JIRA](https://armbian.atlassian.net/jira/dashboards/10000)
|
||||||
- Office hours: [Wednesday, 12 midday, 18 afternoon, CET](https://calendly.com/armbian/office-hours)
|
- Office hours: [Wednesday, 12 midday, 18 afternoon, CET](https://calendly.com/armbian/office-hours)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user