Skip to content

Commit 3bc738b

Browse files
gmarullcarlescufi
authored andcommitted
readme: add versioning scheme information
Mention that example-application follow Zephyr version scheme. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent 301b6e0 commit 3bc738b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Diff for: README.md

+8
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,17 @@ applications. Some of the features demonstrated in this example are:
1010
- Out-of-tree [drivers][drivers]
1111
- Example CI configuration (using Github Actions)
1212

13+
This repository is versioned together with the [Zephyr main tree][zephyr]. This
14+
means that every time that Zephyr is tagged, this repository is tagged as well
15+
with the same version number, and the [manifest](west.yml) entry for `zephyr`
16+
will point to the corresponding Zephyr tag. For example, `example-application`
17+
v2.6.0 will point to Zephyr v2.6.0. Note that the `main` branch will always
18+
point to the development branch of Zephyr, also `main`.
19+
1320
[board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html
1421
[bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html
1522
[drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html
23+
[zephyr]: https://github.com/zephyrproject-rtos/zephyr
1624

1725
## Getting Started
1826

0 commit comments

Comments
 (0)