From 0f8953f70aa14900eb2a35afa912b291eccbddc1 Mon Sep 17 00:00:00 2001 From: Alex Gonzalez Date: Thu, 10 Aug 2023 13:40:48 +0200 Subject: [PATCH] README: Update build instructions Update the build instructions with steps for containerized builds. Changelog-entry: Update build instructions in README Signed-off-by: Alex Gonzalez --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aec94cb..62896c5 100644 --- a/README.md +++ b/README.md @@ -29,24 +29,36 @@ bring in all the needed dependencies. ## Build information -### Build flags +balenaOS currently only builds with cgroups v1. If your distribution defaults +to using cgroups v2, please boot with the following kernel command line +argument: +`systemd.unified_cgroup_hierarchy=0` -* Consult layers/meta-balena/README.md for info on various build flags (setting -up serial console support for example) and build prerequisites. Build flags can -be set by using the build script (barys) or by manually modifying `local.conf`. +### Containerized build -See below for using the build script. +* If you have a working docker installation, you can build in a containerized + environment as follows: + `./balena-yocto-scripts/build/balena-build.sh -d -s ` -### Build this repository + Where: + * Device type is one of the supported devices with a valid `.coffee` description file. + * Shared directory is the absolute path to the build folder -* Run the build script: +### Native build + +To build all supported device types natively, please make sure your Linux +distribution is [supported](https://docs.yoctoproject.org/singleindex.html#supported-linux-distributions) by Yocto Project. + +Additional host tools need to be installed for native builds to work. + +* Run the barys build script: `./balena-yocto-scripts/build/barys` * You can also run barys with the -h switch to inspect the available options ### Custom build using this repository -* Run the build script in dry run mode to setup an empty `build` directory +* Run the barys build script in dry run mode to setup an empty `build` directory `./balena-yocto-scripts/build/barys --remove-build --dry-run` * Edit the `local.conf` in the `build/conf` directory @@ -56,6 +68,13 @@ See below for using the build script. * Run bitbake (see message outputted when you sourced above for examples) +### Build flags + +* Consult layers/meta-balena/README.md for info on various build flags (setting +up serial console support for example) and build prerequisites. Build flags can +be set by using the build scripts (barys or balena-build) or by manually +modifying `local.conf`. + ## Contributing ### Issues