begriffs open source - cmsis-driver-validation/blob - README.md

   1 # CMSIS Driver Validation
   2
   3 The branch *master* of this GitHub repository contains the CMSIS-Driver Validation Version 1.2.0.  The [documentation](http://arm-software.github.io/CMSIS-Driver_Validation/General/html/index.html) is available under
   4  http://arm-software.github.io/CMSIS-Driver_Validation/html/index.html
   5
   6 Use [Issues](https://github.com/ARM-software/CMSIS-Driver_Validation#issues-and-labels) to provide feedback and report problems for CMSIS-Driver Validation Version 1.1.0.
   7
   8 **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.
   9
  10 ## Directory Structure
  11
  12 | Directory        | Content                                                   |
  13 | ---------------- | --------------------------------------------------------- |
  14 | Boards           | Driver Validation Projects for a set of boards            |
  15 | DoxyGen          | Source of the documentation                               |
  16 | Include          | header files for driver validation components             |
  17 | Source           | source files for driver validation components             |
  18 | Tools            | SockServer source and executable files                    |
  19 | Utilities        | Utility programs                                          |
  20
  21 ## Generate CMSIS Pack for Release
  22
  23 To build a complete CMSIS pack for installation the following additional tools are required:
  24  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  25  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  26  - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
  27
  28 Using these tools, you can generate on a Windows PC:
  29  - **CMSIS Software Pack** using the batch file **gen_pack.bat** (located in ./CMSIS/Utilities). This batch file also generates the documentation.
  30  - **CMSIS Documentation** using the batch file **genDoc.bat** (located in ./CMSIS/Doxygen).
  31
  32 ## License
  33
  34 Arm CMSIS is licensed under Apache-2.0.
  35
  36 ## Contributions and Pull Requests
  37 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.
  38
  39 ### Issues and Labels
  40
  41 Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS-Driver_Validation/issues)
  42 to report misbehavior (i.e. bugs) or start discussions about enhancements. This
  43 is your best way to interact directly with the maintenance team and the community.
  44 We encourage you to append implementation suggestions as this helps to decrease the
  45 workload of the very limited maintenance team.
  46
  47 We will be monitoring and responding to issues as best we can.
  48 Please attempt to avoid filing duplicates of open or closed items when possible.
  49 In the spirit of openness we will be tagging issues with the following:
  50
  51 - **bug** – We consider this issue to be a bug that will be investigated.
  52
  53 - **wontfix** - We appreciate this issue but decided not to change the current behavior.
  54
  55 - **enhancement** – Denotes something that will be implemented soon.
  56
  57 - **future** - Denotes something not yet schedule for implementation.
  58
  59 - **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work.
  60
  61 - **question** – We have further questions to this issue. Please review and provide feedback.
  62
  63 - **documentation** - This issue is a documentation flaw that will be improved in future.
  64
  65 - **review** - This issue is under review. Please be patient.
  66
  67 - **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.
  68
  69 - **duplicate** - This issue is already addressed elsewhere, see comment with provided references.
  70
  71 - **Important Information** - We provide essential informations regarding planned or resolved major enhancements.
  72