diff --git a/README.md b/README.md index 743ce8795d..7668db4962 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,14 @@ [![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_5)](https://github.com/ARM-software/CMSIS_5/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_5)](https://arm-software.github.io/CMSIS_5/General/html/LICENSE.txt) +> **Note:** +> +> Consider to upgrade to [CMSIS Version 6](https://github.com/ARM-software/CMSIS_6). Refer to [Migration from CMSIS v5](https://arm-software.github.io/CMSIS_6/latest/General/index.html#migration_cmsis5) for more information. + The branch *master* of this GitHub repository contains ![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_5?display_name=release&label=%20&sort=semver). The [documentation](http://arm-software.github.io/CMSIS_5/General/html/index.html) is available under http://arm-software.github.io/CMSIS_5/General/html/index.html -Use [Issues](https://github.com/ARM-software/CMSIS_5#issues-and-labels) to provide feedback and report problems for CMSIS Version 5. +Use [Issues on CMSIS_6](https://github.com/ARM-software/CMSIS_6#issues-and-labels) to provide feedback and report problems for CMSIS Version 5. **Note:** The branch *develop* of this GitHub repository reflects our current state of development and is constantly updated. It gives our users and partners contiguous access to the CMSIS development. It allows you to review the work and provide feedback or create pull requests for contributions. @@ -88,39 +92,8 @@ Arm CMSIS is licensed under Apache 2.0. ## Contributions and Pull Requests -Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code. - -### Issues and Labels - -Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS_5/issues) -to report misbehavior (i.e. bugs) or start discussions about enhancements. This -is your best way to interact directly with the maintenance team and the community. -We encourage you to append implementation suggestions as this helps to decrease the -workload of the very limited maintenance team. - -We will be monitoring and responding to issues as best we can. -Please attempt to avoid filing duplicates of open or closed items when possible. -In the spirit of openness we will be tagging issues with the following: - -- **bug** – We consider this issue to be a bug that will be investigated. - -- **wontfix** - We appreciate this issue but decided not to change the current behavior. - -- **enhancement** – Denotes something that will be implemented soon. - -- **future** - Denotes something not yet schedule for implementation. - -- **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work. - -- **question** – We have further questions to this issue. Please review and provide feedback. - -- **documentation** - This issue is a documentation flaw that will be improved in future. - -- **review** - This issue is under review. Please be patient. - -- **DONE** - We consider this issue as resolved - please review and close it. In case of no further activity this issues will be closed after a week. - -- **duplicate** - This issue is already addressed elsewhere, see comment with provided references. +CMSIS Version 5 is no longer the development release. Consider to contribute to [CMSIS Verison 6](https://github.com/ARM-software/CMSIS_6) instead. -- **Important Information** - We provide essential information regarding planned or resolved major enhancements. +### Issues +Raise [issues in the CMSIS Version 6 repository](https://github.com/ARM-software/CMSIS_6/issues) as CMSIS Version 5 is no longer the development release.