Skip to content

Commit 6bb9559

Browse files
committed
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 <alexg@balena.io>
1 parent 32bd79d commit 6bb9559

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.md

+27-8
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,36 @@ bring in all the needed dependencies.
1010

1111
## Build information
1212

13-
### Build flags
13+
balenaOS currently only builds with cgroups v1. If your distribution defaults
14+
to using cgroups v2, please boot with the following kernel command line
15+
argument:
16+
`systemd.unified_cgroup_hierarchy=0`
1417

15-
* Consult layers/meta-balena/README.md for info on various build flags (setting
16-
up serial console support for example) and build prerequisites. Build flags can
17-
be set by using the build script (barys) or by manually modifying `local.conf`.
18+
### Containerized build
19+
20+
* If you have a working docker installation, you can build in a containerized
21+
environment as follows:
22+
`./balena-yocto-scripts/build/balena-build.sh -d <device type> -s <shared directory>`
23+
24+
Where:
25+
* Device type is one of the supported devices with a valid `<device type name>.coffee` description file.
26+
* Shared directory is the absolute path to the build folder
27+
28+
### Native build
1829

19-
See below for using the build script.
30+
To build all supported device types natively, please make sure your Linux
31+
distribution is [supported](https://docs.yoctoproject.org/singleindex.html#supported-linux-distributions) by Yocto Project.
2032

21-
### Build this repository
33+
Additional host tools need to be installed for native builds to work.
2234

23-
* Run the build script:
35+
* Run the barys build script:
2436
`./balena-yocto-scripts/build/barys`
2537

2638
* You can also run barys with the -h switch to inspect the available options
2739

2840
### Custom build using this repository
2941

30-
* Run the build script in dry run mode to setup an empty `build` directory
42+
* Run the barys build script in dry run mode to setup an empty `build` directory
3143
`./balena-yocto-scripts/build/barys --remove-build --dry-run`
3244

3345
* Edit the `local.conf` in the `build/conf` directory
@@ -37,6 +49,13 @@ See below for using the build script.
3749

3850
* Run bitbake (see message outputted when you sourced above for examples)
3951

52+
### Build flags
53+
54+
* Consult layers/meta-balena/README.md for info on various build flags (setting
55+
up serial console support for example) and build prerequisites. Build flags can
56+
be set by using the build scripts (barys or balena-build) or by manually
57+
modifying `local.conf`.
58+
4059
## Contributing
4160

4261
### Issues

0 commit comments

Comments
 (0)