Skip to content

Commit a250628

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 <[email protected]>
1 parent 094bba6 commit a250628

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
@@ -12,24 +12,36 @@ bring in all the needed dependencies.
1212

1313
## Build information
1414

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

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

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

23-
### Build this repository
35+
Additional host tools need to be installed for native builds to work.
2436

25-
* Run the build script:
37+
* Run the barys build script:
2638
`./balena-yocto-scripts/build/barys`
2739

2840
* You can also run barys with the -h switch to inspect the available options
2941

3042
### Custom build using this repository
3143

32-
* Run the build script in dry run mode to setup an empty `build` directory
44+
* Run the barys build script in dry run mode to setup an empty `build` directory
3345
`./balena-yocto-scripts/build/barys --remove-build --dry-run`
3446

3547
* Edit the `local.conf` in the `build/conf` directory
@@ -39,6 +51,13 @@ See below for using the build script.
3951

4052
* Run bitbake (see message outputted when you sourced above for examples)
4153

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

4463
### Issues

0 commit comments

Comments
 (0)