From acf2df5f64515f9ead9385068bc621034fb25b34 Mon Sep 17 00:00:00 2001 From: Pekka Niskanen Date: Thu, 29 Dec 2022 16:09:09 +0200 Subject: [PATCH] doc: cleaning up the readme.md Cleaning up the language and formatting in the README.md document file. Signed-off-by: Pekka Niskanen --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 88a1c98..91c3143 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Zephyr 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 +repository is to serve as a reference on how to structure Zephyr-based applications. Some of the features demonstrated in this example are: - 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 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` -will point to the corresponding Zephyr tag. For example, `example-application` -v2.6.0 will point to Zephyr v2.6.0. Note that the `main` branch will always -point to the development branch of Zephyr, also `main`. +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`. [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 @@ -33,14 +33,14 @@ point to the development branch of Zephyr, also `main`. ## Getting Started 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). ### Initialization 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 -that by running: +the ``example-application`` and all Zephyr modules will be cloned. Run the following +command: ```shell # initialize my-workspace for the example-application (main branch) @@ -50,26 +50,29 @@ cd my-workspace west update ``` -### Build & Run +### Building and running -The application can be built by running: +To build the application, run the following command: ```shell west build -b $BOARD app ``` -where `$BOARD` is the target board. The `custom_plank` board found in this -repository can be used. Note that Zephyr sample boards may be used if an +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`). -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 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 have built the application you can flash it by running: +You can also use it together with the `rtt.conf` file if using Segger RTT. Once +you have built the application, run the following command to flash it: ```shell west flash