11# Zephyr Example Application
22
33This 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
4+ repository is to serve as a reference on how to structure Zephyr- based
55applications. Some of the features demonstrated in this example are:
66
77- Basic [ Zephyr application] [ app_dev ] skeleton
@@ -17,9 +17,9 @@ applications. Some of the features demonstrated in this example are:
1717This repository is versioned together with the [ Zephyr main tree] [ zephyr ] . This
1818means that every time that Zephyr is tagged, this repository is tagged as well
1919with the same version number, and the [ manifest] ( west.yml ) entry for ` zephyr `
20- will point to the corresponding Zephyr tag. For example, ` example-application `
21- v2.6.0 will point to Zephyr v2.6.0. Note that the ` main ` branch will always
22- point to the development branch of Zephyr, also ` main ` .
20+ will point to the corresponding Zephyr tag. For example, the ` example-application `
21+ v2.6.0 will point to Zephyr v2.6.0. Note that the ` main ` branch always
22+ points to the development branch of Zephyr, also ` main ` .
2323
2424[ app_dev ] : https://docs.zephyrproject.org/latest/develop/application/index.html
2525[ workspace_app ] : https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app
@@ -33,14 +33,14 @@ point to the development branch of Zephyr, also `main`.
3333## Getting Started
3434
3535Before getting started, make sure you have a proper Zephyr development
36- environment. You can follow the official
36+ environment. Follow the official
3737[ Zephyr Getting Started Guide] ( https://docs.zephyrproject.org/latest/getting_started/index.html ) .
3838
3939### Initialization
4040
4141The first step is to initialize the workspace folder (`` my-workspace `` ) where
42- the `` example-application `` and all Zephyr modules will be cloned. You can do
43- that by running :
42+ the `` example-application `` and all Zephyr modules will be cloned. Run the following
43+ command :
4444
4545``` shell
4646# initialize my-workspace for the example-application (main branch)
@@ -50,26 +50,29 @@ cd my-workspace
5050west update
5151```
5252
53- ### Build & Run
53+ ### Building and running
5454
55- The application can be built by running :
55+ To build the application, run the following command :
5656
5757``` shell
5858west build -b $BOARD app
5959```
6060
61- where ` $BOARD ` is the target board. The ` custom_plank ` board found in this
62- repository can be used. Note that Zephyr sample boards may be used if an
61+ where ` $BOARD ` is the target board.
62+
63+ You can use the ` custom_plank ` board found in this
64+ repository. Note that Zephyr sample boards may be used if an
6365appropriate overlay is provided (see ` app/boards ` ).
6466
65- A sample debug configuration is also provided. You can apply it by running:
67+ A sample debug configuration is also provided. To apply it, run the following
68+ command:
6669
6770``` shell
6871west build -b $BOARD app -- -DOVERLAY_CONFIG=debug.conf
6972```
7073
71- Note that you may also use it together with ` rtt.conf ` if using Segger RTT. Once
72- you have built the application you can flash it by running :
74+ You can also use it together with the ` rtt.conf ` file if using Segger RTT. Once
75+ you have built the application, run the following command to flash it :
7376
7477``` shell
7578west flash
0 commit comments