diff options
-rw-r--r-- | README | 34 | ||||
-rw-r--r-- | README.md | 47 |
2 files changed, 47 insertions, 34 deletions
diff --git a/README b/README deleted file mode 100644 index 6745e069..00000000 --- a/README +++ /dev/null | |||
@@ -1,34 +0,0 @@ | |||
1 | OpenEmbedded/Yocto BSP layer for Freescale's platforms | ||
2 | ====================================================== | ||
3 | |||
4 | This layer provides support for Freescale's platforms for use with | ||
5 | OpenEmbedded and/or Yocto. | ||
6 | |||
7 | This layer depends on: | ||
8 | |||
9 | URI: git://git.openembedded.org/openembedded-core | ||
10 | branch: master | ||
11 | revision: HEAD | ||
12 | |||
13 | Contributing | ||
14 | ------------ | ||
15 | |||
16 | Please submit any patches against the `meta-freescale` layer by using the | ||
17 | GitHub pull-request feature. Fork the repo, make a branch, do the | ||
18 | work, rebase from upstream, create the pull request. | ||
19 | |||
20 | For some useful guidelines to be followed when submitting patches, | ||
21 | please refer to: | ||
22 | http://openembedded.org/wiki/Commit_Patch_Message_Guidelines | ||
23 | |||
24 | Pull requests will be discussed within the GitHub pull-request | ||
25 | infrastructure. If you want to get informed on new PRs and the | ||
26 | follow-up discussions please use the GitHub's notification system. | ||
27 | |||
28 | Mailing list: | ||
29 | |||
30 | https://lists.yoctoproject.org/g/meta-freescale | ||
31 | |||
32 | Source code: | ||
33 | |||
34 | https://github.com/Freescale/meta-freescale | ||
diff --git a/README.md b/README.md new file mode 100644 index 00000000..786e950b --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,47 @@ | |||
1 | # OpenEmbedded/Yocto Project BSP Layer for NXP's Platforms | ||
2 | |||
3 | Welcome to `meta-freescale`. This document outlines our commitment to providing consistent support and updates in alignment with the Yocto Project LTS release schedule. | ||
4 | |||
5 | This layer provides support for NXP's platforms for use with OpenEmbedded and/or Yocto Project. | ||
6 | |||
7 | ### Dependencies | ||
8 | |||
9 | This layer depends on: | ||
10 | |||
11 | - URI: git://git.openembedded.org/openembedded-core | ||
12 | - Branch: master | ||
13 | - Revision: HEAD | ||
14 | |||
15 | ## Branches | ||
16 | |||
17 | - **master:** This is our primary development branch, receiving continuous bug fixes and BSP upgrades. It represents the latest and greatest version, ensuring compatibility with the most recent Yocto Project release. | ||
18 | - **scarthgap:** Associated with Yocto Project 5.0 (LTS), maintained until April 2028 for bug fixes and until April 2026 for BSP backports. | ||
19 | - **nanbield:** Corresponding to Yocto Project 4.3, it's maintained until May 2024 for bug fixes and BSP backports. | ||
20 | - **kirkstone:** Tied to Yocto Project 4.0 (LTS), supported until April 2026 for bug fixes and until April 2024 for BSP backports. | ||
21 | |||
22 | ## Maintenance Policy | ||
23 | |||
24 | - **Latest and Greatest (Master):** Continuous attention to bug fixes and BSP upgrades, ensuring that our users have access to the latest enhancements and improvements. | ||
25 | - **Stable Releases:** Each stable release is maintained until the subsequent version is released. This includes backports for BSP and critical bug fixes, along with updates for security vulnerabilities (CVEs). | ||
26 | - **Long-Term Support (LTS) Releases:** These are maintained for the duration of Yocto Project's LTS support. We prioritize bug fixes, security vulnerabilities (CVEs) updates, and BSP backports to ensure stability and reliability. | ||
27 | |||
28 | This policy ensures that our users can rely on consistent support and updates, backed by our commitment to delivering high-quality BSP layers. | ||
29 | |||
30 | ## Release Cycle | ||
31 | |||
32 | - **Yocto Project LTS Releases:** Our LTS branches follow the Yocto Project LTS release schedule, which involves a four-year maintenance period. A new LTS version is typically released every two years. | ||
33 | - **Stable Releases:** We aim to provide stable releases every six months, aligning with the pace of Yocto Project's stable releases. | ||
34 | |||
35 | ## Contributing | ||
36 | |||
37 | Please submit any patches against the `meta-freescale` layer by using the GitHub pull-request feature. Fork the repo, create a branch, do the work, rebase from upstream, and then create the pull request. | ||
38 | |||
39 | For useful guidelines on submitting patches, please refer to the [Commit Patch Message Guidelines](http://openembedded.org/wiki/Commit_Patch_Message_Guidelines). | ||
40 | |||
41 | Pull requests will be discussed within the GitHub pull-request infrastructure. If you want to stay informed about new PRs and follow-up discussions, please use GitHub's notification system. Additionally, feel free to open GitHub issues for bug reports, feature requests, or general discussions. | ||
42 | |||
43 | ## Communication | ||
44 | |||
45 | - **GitHub Issues:** [meta-freescale issues](https://github.com/Freescale/meta-freescale/issues) | ||
46 | - **GitHub Discussions:** [meta-freescale discussions](https://github.com/Freescale/meta-freescale/discussions) | ||
47 | - **Pull Requests:** [meta-freescale pull requests](https://github.com/Freescale/meta-freescale/pulls) | ||