Skip to content

Commit 0c992ac

Browse files
committed
Adjust text on main README.md (#6062)
1 parent a9ab97f commit 0c992ac

File tree

1 file changed

+28
-31
lines changed

1 file changed

+28
-31
lines changed

README.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,14 @@
1717

1818
## Getting started
1919

20-
### Basic requirements
20+
### Requirements
2121

22-
- 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
23-
- Ubuntu Jammy 22.04.x amd64 or aarch64 for native building or any Docker capable amd64 / aarch64 Linux for containerised
22+
- x86_64 / aarch64 machine
23+
- at least 2GB of memory and ~35GB of disk space for VM, container or bare metal installation
24+
- Ubuntu Jammy 22.04.x for native building or any Docker capable Linux for containerised
25+
- Windows 10/11 with WSL2 subsystem running Ubuntu Jammy 22.04.x
2426
- Superuser rights (configured sudo or root access).
25-
- Make sure all your system components are up-to-date. Outdated Docker binaries, for example, can cause trouble.
27+
- Make sure your system is up-to-date! Outdated Docker binaries, for example, can cause trouble.
2628

2729
### Start with the build script
2830

@@ -59,11 +61,11 @@ Show work-in-progress areas in interactive mode:
5961
./compile.sh EXPERT="yes"
6062
```
6163

62-
Build minimal CLI Armbian Jammy image for Orangepi Zero. Use `current` kernel and write image to the SD card:
64+
Build minimal CLI Armbian Jammy for Raspberry Pi 4B with LTS kernel and write image directly to the SD card:
6365

6466
```bash
6567
./compile.sh \
66-
BOARD=orangepizero \
68+
BOARD=rpi4b \
6769
BRANCH=current \
6870
RELEASE=jammy \
6971
BUILD_MINIMAL=yes \
@@ -74,15 +76,20 @@ CARD_DEVICE="/dev/sdX"
7476

7577
More information:
7678

77-
- [Building Armbian](https://docs.armbian.com/Developer-Guide_Build-Preparation/) how to start, how to automate;
78-
- [Build options](https://docs.armbian.com/Developer-Guide_Build-Options/) all build options;
79-
- [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) how to add packages, patches, and override sources config;
79+
- [Building Armbian](https://docs.armbian.com/Developer-Guide_Build-Preparation/) (how to start, how to automate)
80+
- [Build options](https://docs.armbian.com/Developer-Guide_Build-Options/) (all build options)
81+
- [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) (how to add packages, patches, and override sources config)
8082

81-
## Download prebuilt images
83+
## Download prebuilt images releases
8284

83-
- [quarterly released **supported** builds](https://www.armbian.com/download/?device_support=Standard%20support)
84-
- [quarterly released **community maintained** builds](https://www.armbian.com/download/?device_support=Community%20maintained)
85-
- [automatic released **rolling release** builds](https://github.com/armbian/os/releases/latest) (daily or when code changes)
85+
### Point
86+
87+
- [manually released **standard supported** builds](https://www.armbian.com/download/?device_support=Standard%20support) (quarterly)
88+
89+
### Rolling
90+
91+
- [automatically released **staging and standard supported** builds](https://github.com/armbian/os/releases/latest) (daily)
92+
- [automatically released **community maintained** builds](https://github.com/armbian/community/releases/latest) (weekly)
8693

8794
## Compared with industry standards
8895

@@ -182,25 +189,15 @@ Function | Armbian | Yocto | Buildroot |
182189

183190
## Contribution
184191

185-
### You don't need to be a programmer to help!
186-
187-
The easiest way to help is by "Starring" our repository - it helps more people find our code.
188-
189-
- [Check out our list of volunteer positions](https://forum.armbian.com/staffapplications/) and choose what you want to do ❤️
190-
- [Mirror our download infrastructure](https://github.com/armbian/mirror/) ❤️
191-
- [Donate](https://www.armbian.com/donate)! ❤️
192-
193-
### Want to become a maintainer?
194-
195-
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/) !
192+
### Want to help?
196193

197-
### Want to become a developer?
194+
We always need those volunteering positions:
198195

199-
To help with development, review [this document](CONTRIBUTING.md) and move straight to the code:
196+
- [Code reviewer](https://forum.armbian.com/staffapplications/application/23-code-reviewer/)
197+
- [Build framework maintainer](https://forum.armbian.com/staffapplications/application/9-build-framework-maintainer/)
198+
- [Test Automation Engineer](https://forum.armbian.com/staffapplications/application/19-test-automation-engineer/)
200199

201-
- [release related tickets](https://www.armbian.com/participate/)
202-
- [review pull requests](https://github.com/armbian/build/pulls?q=is%3Apr+is%3Aopen+review%3Arequired+label%3A%22Needs+review%22)
203-
- ticket dashboard for [junior](https://armbian.atlassian.net/jira/dashboards/10000) and [seniors](https://armbian.atlassian.net/jira/dashboards/10103) developers
200+
Just apply and follow!
204201

205202
## Support
206203

@@ -216,9 +213,9 @@ Free support:
216213
## Contact
217214

218215
- [Forums](https://forum.armbian.com) for Participate in Armbian
219-
- IRC: `#armbian` on Libera.chat
216+
- IRC: `#armbian` on Libera.chat / oftc.net
220217
- Discord: [https://discord.gg/armbian](https://discord.gg/armbian)
221-
- 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).
218+
- Follow [@armbian](https://twitter.com/armbian) on 𝕏 (formerly known as Twitter), [Fosstodon](https://fosstodon.org/@armbian) or [LinkedIn](https://www.linkedin.com/company/armbian).
222219
- Bugs: [issues](https://github.com/armbian/build/issues) / [JIRA](https://armbian.atlassian.net/jira/dashboards/10000)
223220
- Office hours: [Wednesday, 12 midday, 18 afternoon, CET](https://calendly.com/armbian/office-hours)
224221

0 commit comments

Comments
 (0)