From da028f1ca3b4fa073e866e6d1461832f85f0254c Mon Sep 17 00:00:00 2001 From: Igor Pecovnik Date: Thu, 24 May 2018 15:05:11 +0200 Subject: [PATCH] Updated readme, changed supported build environment to Bionic --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7e56d7d8c0..deefc396fe 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -# Armbian +# Armbian # -Ubuntu and Debian images for ARM based single-board computers -https://www.armbian.com +Debian based Linux for ARM based single-board computers -## How to build my own image or kernel? +---------- +[https://www.armbian.com](https://www.armbian.com "Armbian") -Supported build environments: -- [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) guest inside a [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or other virtualization software, -- [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) guest managed by [Vagrant](https://www.vagrantup.com/). This uses Virtualbox (as above) but does so in an easily repeatable way. Please check the [Armbian with Vagrant README](https://docs.armbian.com/Developer-Guide_Using-Vagrant/) for a quick start HOWTO, -- [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) inside a [Docker](https://www.docker.com/), [systemd-nspawn](https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html) or other container environment [(example)](https://github.com/igorpecovnik/lib/pull/255#issuecomment-205045273). Building full OS images inside containers may not work, so this option is mostly for the kernel compilation, -- [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) running natively on a dedicated PC or a server (**not** recommended unless you build kernel only, for full OS images always use virtualization as outlined above), +# How to build an image or a kernel? + +Supported build environments is **Ubuntu Bionic 18.04 x64** ([minimal iso image](http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso)). + +- guest inside a [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or other virtualization software, +- guest managed by [Vagrant](https://www.vagrantup.com/). This uses Virtualbox (as above) but does so in an easily repeatable way. Please check the [Armbian with Vagrant README](https://docs.armbian.com/Developer-Guide_Using-Vagrant/) for a quick start HOWTO, +- inside a [Docker](https://www.docker.com/), [systemd-nspawn](https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html) or other container environment [(example)](https://github.com/armbian/build/pull/255#issuecomment-205045273), +- running natively on a dedicated PC or a server (**not** recommended), - **20GB disk space** or more and **2GB RAM** or more available for the VM, container or native OS, - superuser rights (configured `sudo` or root access). @@ -27,13 +30,22 @@ You will be prompted with a selection menu for a build option, a board name, a k Build process uses caching for the compilation and the debootstrap process, so consecutive runs with similar settings will be much faster. -## Reporting issues +# How to report issues? Please read [this](https://github.com/igorpecovnik/lib/blob/master/.github/ISSUE_TEMPLATE.md) notice first before opening an issue. -## More info: +# How to contribute? -- [Documentation](https://docs.armbian.com/Developer-Guide_Build-Preparation/) -- [Prebuilt images](https://www.armbian.com/download/) +- [Fork](https://help.github.com/articles/fork-a-repo/) the project +- Make one or more well commented and clean commits to the repository. +- Perform a [pull request](https://help.github.com/articles/creating-a-pull-request/) in github's web interface. + +If it is a new feature request, don't start the coding first. Remember to [open an issue](https://guides.github.com/features/issues/) to discuss the new feature. + +If you are struggling, check [this detailed step by step guide on contributing](https://www.exchangecore.com/blog/contributing-concrete5-github/). + +## Where to get more info? + +- [Documentation](https://docs.armbian.com/Developer-Guide_Build-Preparation/ "Developer resources") +- [Prebuilt images](https://www.armbian.com/download/ "Download section") - [Support forums](https://forum.armbian.com/ "Armbian support forum") -- [Project at Github](https://github.com/igorpecovnik/lib)