From daf504561c677b4096c3940182f0a04f35342ac6 Mon Sep 17 00:00:00 2001 From: Andre Detsch Date: Mon, 18 Nov 2024 20:24:26 -0300 Subject: [PATCH] readme: Add section guiding testing on devices Signed-off-by: Andre Detsch --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index ffd6398c..f77c8838 100644 --- a/README.md +++ b/README.md @@ -170,3 +170,18 @@ done Aktualizr-lite provides an API that can be used for creating a custom update client. An example of such client is available at https://github.com/foundriesio/sotactl + +### Testing Changes on Device + +The easiest way to build an aktualizr-lite executable that is compatible with the LmP environment used in a device +is to use `bitbake` in conjunction with the Yocto layers from the device's Factory. +In order to use a local source tree during build, a custom bitbake workflow can be employed, as described in +https://foundries.io/insights/blog/yocto-hack-for-everyone/. + +When dealing with hardware independent logic, +the recommended way of testing is using the [containerized development environment](#development-and-testing-in-containerized-environment). +Alternatively, a Qemu environment can also be used. +The specific instructions on use of Qemu as a FoundriesFactory device varies according to the architecture in use: +- [X86-64](https://docs.foundries.io/94/user-guide/qemu/x86_64.html) +- [ARM64](https://docs.foundries.io/94/user-guide/qemu/arm64.html) +- [ARM](https://docs.foundries.io/94/user-guide/qemu/arm.html)