diff --git a/LICENSE b/LICENSE index eabac9c..418ff77 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -MIT License - -Copyright (c) 2022 HARDWARIO s.r.o. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +MIT License + +Copyright (c) 2022 HARDWARIO a.s. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 25ebca3..3654887 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,62 @@ -HARDWARIO Logo - -# Build Environment for nRF Connect SDK - -[![CI](https://github.com/hardwario/nrf-connect-sdk-build-docker/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/hardwario/nrf-connect-sdk-build-docker/actions/workflows/main.yml) - -This repository contains Dockerfile definitions for all versions of nRF Connect SDK (NCS) from version `v1.8.0+`. It is useful for continuous integration builds and/or quick setup of the development environment on any desktop machine. - -The environment is based on Ubuntu 20.04 and follows the instructions for [manual installation](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/gs_installing.html) provided by Nordic Semiconductor. - -The pre-built Docker image is available on Docker Hub:
-https://hub.docker.com/r/hardwario/nrf-connect-sdk-build - -## Releases - -Here is the list of the supported releases: - -``` -nRF Connect SDK v1.9.1 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) -nRF Connect SDK v1.9.0 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) -nRF Connect SDK v1.8.0 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) -``` - -## Building - -Start Docker build (replace `X.Y.Z` with the desired version): - -``` -docker build -t nrf-connect-sdk-build:vX.Y.Z ncs-vX.Y.Z -``` - -## Alias - -For a more convenient usage, we recommended to add this alias to your shell (replace `X.Y.Z` with the desired version): - -``` -alias dwest="docker run --rm -it -v `pwd`:/home/build hardwario/nrf-connect-sdk-build:vX.Y.Z west" -``` - -Reload your shell environment and test the functionality: - -``` -dwest --version -``` - -## Usage - -In case of alias, in order to build a project, you have to call the `dwest` command from the top level directory of the West workspace. - -Example: - -``` -dwest build -b zephyr/samples/basic/blinky -d zephyr/samples/basic/blinky/build -``` - -## License - -This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](LICENSE) file for details. - ---- - -Made with ❤️ by [**HARDWARIO s.r.o.**](https://www.hardwario.com) in the heart of Europe. +HARDWARIO Logo + +# Build Environment for nRF Connect SDK + +[![CI](https://github.com/hardwario/nrf-connect-sdk-build-docker/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/hardwario/nrf-connect-sdk-build-docker/actions/workflows/main.yml) + +This repository contains Dockerfile definitions for all versions of nRF Connect SDK (NCS) from version `v1.8.0+`. It is useful for continuous integration builds and/or quick setup of the development environment on any desktop machine. + +The environment is based on Ubuntu 20.04 and follows the instructions for [manual installation](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/gs_installing.html) provided by Nordic Semiconductor. + +The pre-built Docker image is available on Docker Hub:
+https://hub.docker.com/r/hardwario/nrf-connect-sdk-build + +## Releases + +Here is the list of the supported releases: + +``` +nRF Connect SDK v1.9.1 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) +nRF Connect SDK v1.9.0 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) +nRF Connect SDK v1.8.0 (uses GNU Arm Embedded Toolchain 9-2019-q4-major) +``` + +## Building + +Start Docker build (replace `X.Y.Z` with the desired version): + +``` +docker build -t nrf-connect-sdk-build:vX.Y.Z ncs-vX.Y.Z +``` + +## Alias + +For a more convenient usage, we recommended to add this alias to your shell (replace `X.Y.Z` with the desired version): + +``` +alias dwest="docker run --rm -it -v `pwd`:/home/build hardwario/nrf-connect-sdk-build:vX.Y.Z west" +``` + +Reload your shell environment and test the functionality: + +``` +dwest --version +``` + +## Usage + +In case of alias, in order to build a project, you have to call the `dwest` command from the top level directory of the West workspace. + +Example: + +``` +dwest build -b zephyr/samples/basic/blinky -d zephyr/samples/basic/blinky/build +``` + +## License + +This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](LICENSE) file for details. + +--- + +Made with ❤️ by [**HARDWARIO a.s.**](https://www.hardwario.com) in the heart of Europe.