diff --git a/src/nrf52811/README.md b/src/nrf52811/README.md index ab5d2bbe..4e33a941 100644 --- a/src/nrf52811/README.md +++ b/src/nrf52811/README.md @@ -100,6 +100,32 @@ The default SPI Slave pin configuration for nRF52811 is defined in `examples/pla [spi-hdlc-adapter]: https://github.com/openthread/openthread/tree/main/tools/spi-hdlc-adapter +### Building using Docker + +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for building the firmware with UART support: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52811 UART_trans -DOT_THREAD_VERSION=1.2 +``` + +After a successful build, the `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### IEEE EUI-64 address When the Thread device is configured to obtain the Thread Network security credentials with either Thread Commissioning or an out-of-band method, the extended MAC address should be constructed out of the globally unique IEEE EUI-64. diff --git a/src/nrf52833/README.md b/src/nrf52833/README.md index f9ddf0c4..0b275cf6 100644 --- a/src/nrf52833/README.md +++ b/src/nrf52833/README.md @@ -55,6 +55,32 @@ After a successful build, the `elf` files can be found in ` $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ``` +### Building using Docker + +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for building the firmware with USB CDC ACM support: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52833 USB_trans -DOT_THREAD_VERSION=1.2 +``` + +After a successful build, the `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### USB CDC ACM support You can build the libraries with support for the native USB CDC ACM as a serial transport. To do so, build the firmware with the following parameter: diff --git a/src/nrf52840/README.md b/src/nrf52840/README.md index cf8a3043..0ec6ac79 100644 --- a/src/nrf52840/README.md +++ b/src/nrf52840/README.md @@ -60,6 +60,32 @@ After a successful build, the `elf` files can be found in ` $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex ``` +### Building using Docker + +Alternatively, you can build using a Docker image instead of nRF Command Line Tools. + +This can be useful in case of CI/CD builds or to build locally without installing the dependencies. + +Example for the nRF52840 dongle: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch ./script/build nrf52840 USB_trans -DOT_BOOTLOADER=USB -DOT_THREAD_VERSION=1.2 +``` + +After a successful build, the `elf` files can be converted through the same container image. + +For example: + +```bash +cd +docker run --rm -u $(id -u):$(id -g) -v $(pwd):/workdir/project coderbyheart/fw-nrfconnect-nrf-docker:v1.8-branch arm-none-eabi-objcopy -O ihex build/bin/ot-rcp build/bin/ot-rcp.hex +``` + +See [Build NCS application firmware images using Docker][build-ncs-using-docker] for general instructions on using Docker to build an nRF Connect SDK based application. + +[build-ncs-using-docker]: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/getting-started/posts/build-ncs-application-firmware-images-using-docker + ### USB CDC ACM support You can build the libraries with support for the native USB CDC ACM as a serial transport. To do so, build the firmware with the following parameter: