diff --git a/README.md b/README.md index ea82a97..86fa7ef 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Zephyr Example Application +# nRF Connect SDK example application -This repository contains a Zephyr example application. The main purpose of this -repository is to serve as a reference on how to structure Zephyr-based -applications. Some of the features demonstrated in this example are: +This repository contains an nRF Connect SDK example application. The main +purpose of this repository is to serve as a reference on how to structure nRF Connect +SDK based applications. Some of the features demonstrated in this example are: - Basic [Zephyr application][app_dev] skeleton - [Zephyr workspace applications][workspace_app] @@ -15,12 +15,12 @@ applications. Some of the features demonstrated in this example are: - Example CI configuration (using Github Actions) - Custom [west extension][west_ext] -This repository is versioned together with the [Zephyr main tree][zephyr]. This -means that every time that Zephyr is tagged, this repository is tagged as well +This repository is versioned together with the [nRF Connect SDK main tree][sdk-nrf]. This +means that every time that nRF Connect SDK is tagged, this repository is tagged as well with the same version number, and the [manifest](west.yml) entry for `zephyr` -will point to the corresponding Zephyr tag. For example, the `example-application` -v2.6.0 will point to Zephyr v2.6.0. Note that the `main` branch always -points to the development branch of Zephyr, also `main`. +will point to the corresponding nRF Connect SDK tag. For example, the `ncs-example-application` +v2.5.0 will point to nRF Connect SDK v2.5.0. Note that the `main` branch always +points to the development branch of nRF Connect SDK, also `main`. [app_dev]: https://docs.zephyrproject.org/latest/develop/application/index.html [workspace_app]: https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app @@ -29,25 +29,25 @@ points to the development branch of Zephyr, also `main`. [board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html [bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html [drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html -[zephyr]: https://github.com/zephyrproject-rtos/zephyr +[sdk-nrf]: https://github.com/nrfconnect/sdk-nrf [west_ext]: https://docs.zephyrproject.org/latest/develop/west/extensions.html -## Getting Started +## Getting started -Before getting started, make sure you have a proper Zephyr development -environment. Follow the official -[Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html). +Before getting started, make sure you have a proper nRF Connect SDK development environment. +Follow the official +[Installation guide](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/installation/install_ncs.html). ### Initialization The first step is to initialize the workspace folder (``my-workspace``) where -the ``example-application`` and all Zephyr modules will be cloned. Run the following +the ``example-application`` and all nRF Connect SDK modules will be cloned. Run the following command: ```shell -# initialize my-workspace for the example-application (main branch) -west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace -# update Zephyr modules +# initialize my-workspace for the ncs-example-application (main branch) +west init -m https://github.com/nrfconnect/ncs-example-application --mr main my-workspace +# update nRF Connect SDK modules cd my-workspace west update ``` @@ -62,9 +62,8 @@ west build -b $BOARD app where `$BOARD` is the target board. -You can use the `custom_plank` board found in this -repository. Note that Zephyr sample boards may be used if an -appropriate overlay is provided (see `app/boards`). +You can use the `custom_plank` board found in this repository. Note that you can use +Zephyr and nRF Connect SDK sample boards if an appropriate overlay is provided (see `app/boards`). A sample debug configuration is also provided. To apply it, run the following command: diff --git a/app/boards/nucleo_f302r8.overlay b/app/boards/nucleo_f302r8.overlay deleted file mode 100644 index c792480..0000000 --- a/app/boards/nucleo_f302r8.overlay +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Copyright (c) 2021 Nordic Semiconductor ASA - * SPDX-License-Identifier: Apache-2.0 - */ - -/* This devicetree overlay file will be automatically picked by the Zephyr - * build system when building the sample for the nucleo_f302r8 board. It shows - * how the example-application can be built on sample boards already provided - * by Zephyr. - */ - -/ { - examplesensor0: examplesensor_0 { - compatible = "zephyr,examplesensor"; - input-gpios = <&gpioc 13 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>; - }; -}; - -&gpioc { - status = "okay"; -}; diff --git a/app/sample.yaml b/app/sample.yaml index 582bb8f..e1b6126 100644 --- a/app/sample.yaml +++ b/app/sample.yaml @@ -3,12 +3,11 @@ # so that you can easily test all of them locally or in CI. sample: description: Example application - name: example-application + name: example-application common: build_only: true integration_platforms: - custom_plank - - nucleo_f302r8 tests: app.default: {} app.debug: diff --git a/west.yml b/west.yml index 6bb551c..18b85f9 100644 --- a/west.yml +++ b/west.yml @@ -6,17 +6,12 @@ manifest: west-commands: scripts/west-commands.yml remotes: - - name: zephyrproject-rtos - url-base: https://github.com/zephyrproject-rtos + - name: ncs + url-base: https://github.com/nrfconnect projects: - - name: zephyr - remote: zephyrproject-rtos + - name: nrf + remote: ncs + repo-path: sdk-nrf revision: main - import: - # By using name-allowlist we can clone only the modules that are - # strictly needed by the application. - name-allowlist: - - cmsis # required by the ARM port - - hal_nordic # required by the custom_plank board (Nordic based) - - hal_stm32 # required by the nucleo_f302r8 board (STM32 based) + import: true