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
  23 ## Directory Structure
  24
  25 *All CMSIS components will be available by end of March 2016*
  26
  27 | Directory       | Content                                        |
  28 | --------------- | ---------------------------------------------- |
  29 | CMSIS/Core      | CMSIS-Core related files (for release)         |
  30 | CMSIS/Driver    | CMSIS-Driver API headers and template files    |
  31 | CMSIS/RTOS      | RTOS related files (template + include)        |
  32 | CMSIS/DoxyGen   | Source of the documentation                    |
  33 | CMSIS/Utilities | Utility programs                               |
  34
  35 ## Generate Documentation
  36
  37 The following tools are required to generate the documentation:
  38  - *doxygen.exe*  Version: 1.8.2 (Documentation Generator)
  39  - *mscgen.exe*   Version: 0.20  (Message Sequence Chart Converter)
  40
  41 Using these tools, documentation can be generated under Windows
  42 with the batch file *genDoc.bat* in directory CMSIS/DoxyGen/.
  43
  44 The file CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API
  45 documentation.
  46
  47 ## Generate CMSIS Software Pack
  48
  49 *coming soon*