diff --git a/README.md b/README.md index 85567d7d0..caf9e9bb0 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# CMSIS Version 6 - Preview (Work in Progress) +[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/blob/main/LICENSE) -[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://arm-software.github.io/CMSIS_6/General/html/LICENSE) +# CMSIS Version 6 -> **Note:** The branch *main* of this GitHub repository contains ![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6?display_name=release&label=%20&sort=semver). It reflects our current state of development and gives you contiguous access to the CMSIS development for review, feedback, and contributions via pull requests. +> **Note:** The branch *main* of this GitHub repository contains our current state of development and gives you contiguous access to the CMSIS development for review, feedback, and contributions via pull requests. For stable versions ready for productive use please refer to tagged releases, like [![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6?display_name=release&label=%20&sort=semver)](https://github.com/ARM-software/CMSIS_6/releases/latest). ## Useful Links - - [**Documentation of latest release**](https://arm-software.github.io/CMSIS_6/) - access to the CMSIS user's manual. - - [**CMSIS Components**](https://arm-software.github.io/CMSIS_6/latest/General/index.html#cmsis_components) - overview of software, tools, and specification. - - [**Raise Issues**](https://github.com/ARM-software/CMSIS_6#issues-and-labels) - to provide feedback or report problems. - - [**Documentation of development branch**](https://arm-software.github.io/CMSIS_6/develop/General/index.html) - updated from time to time (use [Generate CMSIS Pack for Release](https://github.com/ARM-software/CMSIS_6#generate-cmsis-pack-for-release) for local generation). +- [**Documentation of latest release**](https://arm-software.github.io/CMSIS_6/) - access to the CMSIS user's manual. +- [**CMSIS Components**](https://arm-software.github.io/CMSIS_6/latest/General/index.html#cmsis_components) - overview of software, tools, and specification. +- [**Raise Issues**](https://github.com/ARM-software/CMSIS_6#issues-and-labels) - to provide feedback or report problems. +- [**Documentation of main branch**](https://arm-software.github.io/CMSIS_6/main/General/index.html) - updated from time to time (use [Generate CMSIS Pack for Release](https://github.com/ARM-software/CMSIS_6#generate-cmsis-pack-for-release) for local generation). ## Other related GitHub repositories @@ -17,7 +17,7 @@ |:--------------------------- |:--------------------------------------------------------- | | [CMSIS-DSP](https://github.com/ARM-software/CMSIS-DSP) | Compute library for various data types: fixed-point (fractional q7, q15, q31) and single precision floating-point (32-bit). | [CMSIS-NN](https://github.com/ARM-software/CMSIS-NN) | Software library of efficient neural network kernels optimized for Arm Cortex-M processors. -| [CMSIS-FreeRTOS](https://github.com/arm-software/CMSIS-FreeRTOS) | CMSIS adoption of FreeRTOS including CMSIS-RTOS2 API layer. +| [CMSIS-FreeRTOS](https://github.com/arm-software/CMSIS-FreeRTOS) | CMSIS adoption of FreeRTOS including CMSIS-RTOS2 API layer. | [CMSIS-RTX](https://github.com/arm-software/CMSIS-rtx) | Keil RTX Real-Time Operating System (CMSIS-RTOS2 native implementation). | [CMSIS-Driver](https://github.com/arm-software/CMSIS-Driver) | Generic MCU driver implementations and templates for Ethernet MAC/PHY and Flash. | | [CMSIS-Driver_Validation](https://github.com/ARM-software/CMSIS-Driver_Validation) | CMSIS-Driver Validation can be used to verify CMSIS-Driver in a user system | @@ -57,11 +57,11 @@ Using these tools, you can generate on a Windows PC: ## License -Arm CMSIS is licensed under Apache 2.0. +Arm CMSIS is licensed under [![License](https://img.shields.io/github/license/arm-software/CMSIS_6?label)](https://github.com/ARM-software/CMSIS_6/blob/main/LICENSE). ## Contributions and Pull Requests -Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code. +Contributions are accepted under [![License](https://img.shields.io/github/license/arm-software/CMSIS_6?label)](https://github.com/ARM-software/CMSIS_6/blob/main/LICENSE). Only submit contributions where you have authored all of the code. ### Issues and Labels @@ -76,24 +76,13 @@ 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. - - **Important Information** - We provide essential information regarding planned or resolved major enhancements. -