begriffs open source - cmsis/blob - README.md

   1 # CMSIS Version 5 Development Repository
   2
   3 CMSIS Version 5.0.0 is scheduled for release in June 2016.
   4
   5 This development repository gives our users and partners contiguous access
   6 to the CMSIS components. It allows you to review the work and provide feedback.
   7 Please use GitHub to discuss and track issues or create pull requests for contributions.
   8
   9 ## Planned Enhancements
  10  - Add support for ARMv8-M Architecture (Mainline and Baseline)
  11
  12  - Improvements for Cortex-A / M hybrid devices (focus on Cortex-M interaction)
  13
  14  - CMSIS-RTOS API and RTX reference implementation with several enhancements:
  15      - Dynamic object creation, Flag events, C and C++ API, additional thread and timer functions
  16      - Secure and Non-Secure support, multi-processor support
  17
  18  - CMSIS-Pack
  19      - Additions for generic example, project templates, multiple download portals
  20      - Adoption of IAR Flash Loader technology
  21
  22 For further details see also the [Slides of the Embedded World CMSIS Partner Meeting](https://github.com/ARM-software/CMSIS_5/blob/master/CMSIS_EW2016.pdf).
  23
  24 ## Directory Structure
  25
  26 *All CMSIS components will be available by end of March 2016*
  27
  28 | Directory       | Content                                        |
  29 | --------------- | ---------------------------------------------- |
  30 | CMSIS/Core      | CMSIS-Core related files (for release)         |
  31 | CMSIS/DAP       | CMSIS-DAP related files and examples           |
  32 | CMSIS/Driver    | CMSIS-Driver API headers and template files    |
  33 | CMSIS/DSP       | CMSIS-DSP related files                        |
  34 | CMSIS/RTOS      | RTOS related files (template + include)        |
  35 | CMSIS/DoxyGen   | Source of the documentation                    |
  36 | CMSIS/Utilities | Utility programs                               |
  37
  38 ## Generate Documentation
  39
  40 The following tools are required to generate the documentation:
  41  - **doxygen.exe**  Version: 1.8.2 (Documentation Generator)
  42  - **mscgen.exe**   Version: 0.20  (Message Sequence Chart Converter)
  43
  44 Using these tools, documentation can be generated under Windows
  45 with the batch file **genDoc.bat** in directory CMSIS/DoxyGen/.
  46
  47 The file CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API
  48 documentation.
  49
  50 ## Generate CMSIS Software Pack
  51
  52 *coming soon*
  53
  54 ## License
  55
  56 ARM CMSIS is licensed under Apache-2.0.
  57
  58 ## Contributions and Pull Requests
  59
  60 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.