Reference project name
Documentation / Build (1.14.0) (push) Failing after 15s
Documentation / Build (1.9.6) (push) Successful in 13s
Documentation / Deploy (push) Has been skipped
Build / Build app and tests (macos-14) (push) Has been cancelled
Build / Build app and tests (windows-2022) (push) Has been cancelled
Build / Build app and tests (ubuntu-22.04) (push) Failing after 1m43s

This commit is contained in:
2026-04-21 21:31:47 -07:00
parent b69d3363f1
commit f07adc33f6
9 changed files with 24 additions and 59 deletions
+9 -44
View File
@@ -1,10 +1,10 @@
# Zephyr Example Application
# LR-EnviroStation
<a href="https://github.com/zephyrproject-rtos/example-application/actions/workflows/build.yml?query=branch%3Amain">
<img src="https://github.com/zephyrproject-rtos/example-application/actions/workflows/build.yml/badge.svg?event=push">
<a href="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/build.yml?query=branch%3Amain">
<img src="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/build.yml/badge.svg?event=push">
</a>
<a href="https://github.com/zephyrproject-rtos/example-application/actions/workflows/docs.yml?query=branch%3Amain">
<img src="https://github.com/zephyrproject-rtos/example-application/actions/workflows/docs.yml/badge.svg?event=push">
<a href="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/docs.yml?query=branch%3Amain">
<img src="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/docs.yml/badge.svg?event=push">
</a>
<a href="https://zephyrproject-rtos.github.io/example-application">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-3D578C?logo=sphinx&logoColor=white">
@@ -13,41 +13,6 @@
<img alt="API Documentation" src="https://img.shields.io/badge/API-documentation-3D578C?logo=c&logoColor=white">
</a>
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
applications. Some of the features demonstrated in this example are:
- Basic [Zephyr application][app_dev] skeleton
- [Zephyr workspace applications][workspace_app]
- [Zephyr modules][modules]
- [West T2 topology][west_t2]
- [Custom boards][board_porting]
- Custom [devicetree bindings][bindings]
- Out-of-tree [drivers][drivers]
- Out-of-tree libraries
- Example CI configuration (using GitHub Actions)
- Custom [west extension][west_ext]
- Custom [Zephyr runner][runner_ext]
- Doxygen and Sphinx documentation boilerplate
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, 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
[modules]: https://docs.zephyrproject.org/latest/develop/modules.html
[west_t2]: https://docs.zephyrproject.org/latest/develop/west/workspaces.html#west-t2
[board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html
[bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html
[drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html
[zephyr]: https://github.com/zephyrproject-rtos/zephyr
[west_ext]: https://docs.zephyrproject.org/latest/develop/west/extensions.html
[runner_ext]: https://docs.zephyrproject.org/latest/develop/modules.html#external-runners
## Getting Started
Before getting started, make sure you have a proper Zephyr development
@@ -57,12 +22,12 @@ environment. Follow the official
### Initialization
The first step is to initialize the workspace folder (``my-workspace``) where
the ``example-application`` and all Zephyr modules will be cloned. Run the following
the ``LR-EnviroStation`` and all Zephyr modules will be cloned. Run the following
command:
```shell
# initialize my-workspace for the example-application (main branch)
west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace
# initialize my-workspace for the LR-EnviroStation (main branch)
west init -m https://git.dungeon.rip/Universe_Prison/LR-EnviroStation --mr main my-workspace
# update Zephyr modules
cd my-workspace
west update
@@ -73,7 +38,7 @@ west update
To build the application, run the following command:
```shell
cd example-application
cd LR-EnviroStation
west build -b $BOARD app
```