diff --git a/README.md b/README.md index 074c5fd..8166960 100644 --- a/README.md +++ b/README.md @@ -69,3 +69,55 @@ Now the generated `index.pidx` can be used with cpackget to validate that all li - invoke `cpackget init ./index.pidx -R ./pack_root_test` to use the generated index.pidx in pack_root_test/.Web/index.pidx - invoke `cpackget --public -R /pack_root_test` to list all latest public pack versions + +## Clone and Build + +```bash +git clone https://github.com/open-cmsis-pack/vidx2pidx +cd vidx2pidx +make +``` + +## License + +vidx2pidx 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/Open-CMSIS-Pack/vidx2pidx/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. + +- **Important Information** - We provide essential informations regarding planned or resolved major enhancements.