From 3bc738b51b4b780f094b3ba6729ee7006864c63c Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Fri, 4 Jun 2021 13:48:51 +0200 Subject: [PATCH] readme: add versioning scheme information Mention that example-application follow Zephyr version scheme. Signed-off-by: Gerard Marull-Paretas --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0c18bfe..8e7821a 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,17 @@ applications. Some of the features demonstrated in this example are: - Out-of-tree [drivers][drivers] - Example CI configuration (using Github Actions) +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`. + [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 ## Getting Started