1- # Zephyr Example Application
1+ # nRF Connect SDK example application
22
3- This repository contains a Zephyr example application. The main purpose of this
4- repository is to serve as a reference on how to structure Zephyr-based
5- applications. Some of the features demonstrated in this example are:
3+ This repository contains an nRF Connect SDK example application. The main
4+ purpose of this repository is to serve as a reference on how to structure nRF Connect
5+ SDK based applications. Some of the features demonstrated in this example are:
66
77- Basic [ Zephyr application] [ app_dev ] skeleton
88- [ Zephyr workspace applications] [ workspace_app ]
@@ -15,12 +15,12 @@ applications. Some of the features demonstrated in this example are:
1515- Example CI configuration (using Github Actions)
1616- Custom [ west extension] [ west_ext ]
1717
18- This repository is versioned together with the [ Zephyr main tree] [ zephyr ] . This
19- means that every time that Zephyr is tagged, this repository is tagged as well
18+ This repository is versioned together with the [ nRF Connect SDK main tree] [ sdk-nrf ] . This
19+ means that every time that nRF Connect SDK is tagged, this repository is tagged as well
2020with the same version number, and the [ manifest] ( west.yml ) entry for ` zephyr `
21- will point to the corresponding Zephyr tag. For example, the ` example-application `
22- v2.6 .0 will point to Zephyr v2.6 .0. Note that the ` main ` branch always
23- points to the development branch of Zephyr , also ` main ` .
21+ will point to the corresponding nRF Connect SDK tag. For example, the ` ncs- example-application`
22+ v2.5 .0 will point to nRF Connect SDK v2.5 .0. Note that the ` main ` branch always
23+ points to the development branch of nRF Connect SDK , also ` main ` .
2424
2525[ app_dev ] : https://docs.zephyrproject.org/latest/develop/application/index.html
2626[ 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`.
2929[ board_porting ] : https://docs.zephyrproject.org/latest/guides/porting/board_porting.html
3030[ bindings ] : https://docs.zephyrproject.org/latest/guides/dts/bindings.html
3131[ drivers ] : https://docs.zephyrproject.org/latest/reference/drivers/index.html
32- [ zephyr ] : https://github.com/zephyrproject-rtos/zephyr
32+ [ sdk-nrf ] : https://github.com/nrfconnect/sdk-nrf
3333[ west_ext ] : https://docs.zephyrproject.org/latest/develop/west/extensions.html
3434
35- ## Getting Started
35+ ## Getting started
3636
37- Before getting started, make sure you have a proper Zephyr development
38- environment. Follow the official
39- [ Zephyr Getting Started Guide ] ( https://docs.zephyrproject.org/ latest/getting_started/index .html ) .
37+ Before getting started, make sure you have a proper nRF Connect SDK development environment.
38+ Follow the official
39+ [ Installation guide ] ( https://developer.nordicsemi.com/nRF_Connect_SDK/doc/ latest/nrf/installation/install_ncs .html ) .
4040
4141### Initialization
4242
4343The first step is to initialize the workspace folder (`` my-workspace `` ) where
44- the `` example-application `` and all Zephyr modules will be cloned. Run the following
44+ the `` example-application `` and all nRF Connect SDK modules will be cloned. Run the following
4545command:
4646
4747``` shell
48- # initialize my-workspace for the example-application (main branch)
49- west init -m https://github.com/zephyrproject-rtos/ example-application --mr main my-workspace
50- # update Zephyr modules
48+ # initialize my-workspace for the ncs- example-application (main branch)
49+ west init -m https://github.com/nrfconnect/ncs- example-application --mr main my-workspace
50+ # update nRF Connect SDK modules
5151cd my-workspace
5252west update
5353```
@@ -62,9 +62,8 @@ west build -b $BOARD app
6262
6363where ` $BOARD ` is the target board.
6464
65- You can use the ` custom_plank ` board found in this
66- repository. Note that Zephyr sample boards may be used if an
67- appropriate overlay is provided (see ` app/boards ` ).
65+ You can use the ` custom_plank ` board found in this repository. Note that you can use
66+ Zephyr and nRF Connect SDK sample boards if an appropriate overlay is provided (see ` app/boards ` ).
6867
6968A sample debug configuration is also provided. To apply it, run the following
7069command:
0 commit comments