Skip to content

Commit

Permalink
Adjust text on main README.md (armbian#6062)
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpecovnik authored Dec 18, 2023
1 parent cc1cedf commit 8bf348a
Showing 1 changed file with 28 additions and 31 deletions.
59 changes: 28 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@

## 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
- Ubuntu Jammy 22.04.x amd64 or aarch64 for native building or any Docker capable amd64 / aarch64 Linux for containerised
- x86_64 / aarch64 machine
- 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).
- 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

Expand Down Expand Up @@ -59,11 +61,11 @@ Show work-in-progress areas in interactive mode:
./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
./compile.sh \
BOARD=orangepizero \
BOARD=rpi4b \
BRANCH=current \
RELEASE=jammy \
BUILD_MINIMAL=yes \
Expand All @@ -74,15 +76,20 @@ CARD_DEVICE="/dev/sdX"

More information:

- [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;
- [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) how to add packages, patches, and override sources config;
- [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)
- [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)
- [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)
### Point

- [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

Expand Down Expand Up @@ -182,25 +189,15 @@ Function | Armbian | Yocto | Buildroot |

## Contribution

### You don't need to be a programmer to help!

The easiest way to help is by "Starring" our repository - it helps more people find our code.

- [Check out our list of volunteer positions](https://forum.armbian.com/staffapplications/) and choose what you want to do ❤️
- [Mirror our download infrastructure](https://github.com/armbian/mirror/) ❤️
- [Donate](https://www.armbian.com/donate)! ❤️

### Want to become a maintainer?

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 help?

### Want to become a developer?
We always need those volunteering positions:

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

- [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
Just apply and follow!

## Support

Expand All @@ -216,9 +213,9 @@ Free support:
## Contact

- [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)
- 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)
- Office hours: [Wednesday, 12 midday, 18 afternoon, CET](https://calendly.com/armbian/office-hours)

Expand Down

0 comments on commit 8bf348a

Please sign in to comment.