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 @@ -OpenEmbedded/Yocto BSP layer for Freescale's platforms -====================================================== - -This layer provides support for Freescale's platforms for use with -OpenEmbedded and/or Yocto. - -This layer depends on: - -URI: git://git.openembedded.org/openembedded-core -branch: master -revision: HEAD - -Contributing ------------- - -Please submit any patches against the `meta-freescale` layer by using the -GitHub pull-request feature. Fork the repo, make a branch, do the -work, rebase from upstream, create the pull request. - -For some useful guidelines to be followed when submitting patches, -please refer to: -http://openembedded.org/wiki/Commit_Patch_Message_Guidelines - -Pull requests will be discussed within the GitHub pull-request -infrastructure. If you want to get informed on new PRs and the -follow-up discussions please use the GitHub's notification system. - -Mailing list: - - https://lists.yoctoproject.org/g/meta-freescale - -Source code: - - https://github.com/Freescale/meta-freescale diff --git a/README.md b/README.md new file mode 100644 index 00000000..91ffff93 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# OpenEmbedded/Yocto Project BSP Layer for NXP's Platforms + +Welcome to `meta-freescale`. This document outlines our commitment to providing consistent support and updates in alignment with the Yocto Project LTS release schedule. + +This layer provides support for NXP's platforms for use with OpenEmbedded and/or Yocto Project. + +### Dependencies + +This layer depends on: + +- URI: git://git.openembedded.org/openembedded-core +- Branch: master +- Revision: HEAD + +## Branches + +- **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. +- **scarthgap:** Associated with Yocto Project 5.0 (LTS), maintained until April 2028 for bug fixes and until April 2026 for BSP backports. +- **nanbield:** Corresponding to Yocto Project 4.3, it's maintained until May 2024 for bug fixes and BSP backports. +- **kirkstone:** Tied to Yocto Project 4.0 (LTS), supported until April 2026 for bug fixes and until April 2024 for BSP backports. + +## Maintenance Policy + +- **Latest and Greatest (Master):** Continuous attention to bug fixes and BSP upgrades, ensuring that our users have access to the latest enhancements and improvements. +- **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). +- **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. + +This policy ensures that our users can rely on consistent support and updates, backed by our commitment to delivering high-quality BSP layers. + +## Release Cycle + +- **Yocto Project LTS Releases:** Our LTS branches follow the [Yocto Project LTS release schedule](https://wiki.yoctoproject.org/wiki/Releases), which involves a four-year maintenance period. A new LTS version is typically released every two years. +- **Stable Releases:** We aim to provide stable releases every six months, aligning with the pace of Yocto Project's stable releases. + +## Contributing + +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. + +For useful guidelines on submitting patches, please refer to the [Commit Patch Message Guidelines](http://openembedded.org/wiki/Commit_Patch_Message_Guidelines). + +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. + +## Communication + +- **GitHub Issues:** [meta-freescale issues](https://github.com/Freescale/meta-freescale/issues) +- **GitHub Discussions:** [meta-freescale discussions](https://github.com/Freescale/meta-freescale/discussions) +- **Pull Requests:** [meta-freescale pull requests](https://github.com/Freescale/meta-freescale/pulls) |