saji/telem3-fw
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

doc: cleaning up the readme.md

Browse source 
Cleaning up the language and formatting in the
README.md document file.

Signed-off-by: Pekka Niskanen <pekka.niskanen@nordicsemi.no>
This commit is contained in:
Pekka Niskanen 2022-12-29 16:09:09 +02:00 committed by Carles Cufí
parent 96aff8a4ee
commit acf2df5f64
1 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,7 +1,7 @@
# Zephyr Example Application # Zephyr Example Application
This repository contains a Zephyr example application. The main purpose of this 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 repository is to serve as a reference on how to structure Zephyr-based
applications. Some of the features demonstrated in this example are: applications. Some of the features demonstrated in this example are:
- Basic [Zephyr application][app_dev] skeleton - Basic [Zephyr application][app_dev] skeleton
@ -17,9 +17,9 @@ applications. Some of the features demonstrated in this example are:
This repository is versioned together with the [Zephyr main tree][zephyr]. This 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 means that every time that Zephyr is tagged, this repository is tagged as well
with the same version number, and the [manifest](west.yml) entry for `zephyr` with the same version number, and the [manifest](west.yml) entry for `zephyr`
will point to the corresponding Zephyr tag. For example, `example-application` 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 will always v2.6.0 will point to Zephyr v2.6.0. Note that the `main` branch always
point to the development branch of Zephyr, also `main`. points to the development branch of Zephyr, also `main`.
[app_dev]: https://docs.zephyrproject.org/latest/develop/application/index.html [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 [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`.
## Getting Started ## Getting Started
Before getting started, make sure you have a proper Zephyr development Before getting started, make sure you have a proper Zephyr development
environment. You can follow the official environment. Follow the official
[Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html). [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
### Initialization ### Initialization
The first step is to initialize the workspace folder (``my-workspace``) where The first step is to initialize the workspace folder (``my-workspace``) where
the ``example-application`` and all Zephyr modules will be cloned. You can do the ``example-application`` and all Zephyr modules will be cloned. Run the following
that by running: command:
```shell ```shell
# initialize my-workspace for the example-application (main branch) # initialize my-workspace for the example-application (main branch)
@ -50,26 +50,29 @@ cd my-workspace
west update west update
``` ```
### Build & Run ### Building and running
The application can be built by running: To build the application, run the following command:
```shell ```shell
west build -b $BOARD app west build -b $BOARD app
``` ```
where `$BOARD` is the target board. The `custom_plank` board found in this where `$BOARD` is the target board.
repository can be used. Note that Zephyr sample boards may be used if an
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`). appropriate overlay is provided (see `app/boards`).
A sample debug configuration is also provided. You can apply it by running: A sample debug configuration is also provided. To apply it, run the following
command:
```shell ```shell
west build -b $BOARD app -- -DOVERLAY_CONFIG=debug.conf west build -b $BOARD app -- -DOVERLAY_CONFIG=debug.conf
``` ```
Note that you may also use it together with `rtt.conf` if using Segger RTT. Once You can also use it together with the `rtt.conf` file if using Segger RTT. Once
you have built the application you can flash it by running: you have built the application, run the following command to flash it:
```shell ```shell
west flash west flash