michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: application: improve example-application section

Browse source 
The 'Example Application' text is similar to but not the same as the
name of the repository, which is example-application. Use the name of
the repository instead. This is easier to search for and plants seeds
in people's memory about where to find it on GitHub.

Add more cross references.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2023-01-05 12:40:26 -08:00 • committed by Carles Cufí
commit 873b63109b
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
doc/develop/application/index.rst
View file

@ -191,25 +191,26 @@ following example, ``app`` is a Zephyr freestanding application:
└── main.c └── main.c
Example workspace application Example workspace application
****************************** *****************************
A reference :ref:`workspace application <zephyr-workspace-app>` contained in its The `example-application`_ Git repository contains a reference :ref:`workspace
own Git repository can be found in the `Example Application`_ repository. application <zephyr-workspace-app>`. It can be used as a reference when
It can be used as a reference on how to structure out-of-tree, Zephyr-based workspace applications creating your own application.
using the :ref:`T2 star topology <west-t2>`. It also demonstrates the out-of-tree
use of features commonly used in applications such as:
- Custom boards The example-application repository demonstrates how to use several
- Custom devicetree bindings commonly-used features, such as:
- Custom drivers
- Continuous Integration (CI) setup - Custom :ref:`board ports <board_porting_guide>`
- An example west :ref:`extension <west-extensions>` command - Custom :ref:`devicetree bindings <dt-bindings>`
- Custom :ref:`device drivers <device_model_api>`
- Continuous Integration (CI) setup, including using :ref:`twister <twister_script>`
- A custom west :ref:`extension command <west-extensions>`
Creating an Application Creating an Application
*********************** ***********************
Follow these steps to create a new application directory. (Refer to Follow these steps to create a new application directory. (Refer to
the `Example Application`_ repository for a reference standalone application in its own Git repository the `example-application`_ repository for a reference standalone application in its own Git repository
or to :ref:`samples-and-demos` for existing applications provided as part of or to :ref:`samples-and-demos` for existing applications provided as part of
Zephyr.) Zephyr.)
@ -1435,4 +1436,4 @@ CONFIG_DEBUG_THREAD_INFO=y in your application.
.. _CMake list: https://cmake.org/cmake/help/latest/manual/cmake-language.7.html#lists .. _CMake list: https://cmake.org/cmake/help/latest/manual/cmake-language.7.html#lists
.. _add_subdirectory(): https://cmake.org/cmake/help/latest/command/add_subdirectory.html .. _add_subdirectory(): https://cmake.org/cmake/help/latest/command/add_subdirectory.html
.. _using Chocolatey: https://chocolatey.org/packages/RapidEE .. _using Chocolatey: https://chocolatey.org/packages/RapidEE
.. _Example Application: https://github.com/zephyrproject-rtos/example-application .. _example-application: https://github.com/zephyrproject-rtos/example-application