diff options
| author | Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com> | 2021-07-27 23:25:55 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-27 23:25:55 +0300 |
| commit | 54f55591d8c38162f03d9645fe7bda3e2a38dd0f (patch) | |
| tree | 1d25033d2590848efe96aebc302a3cb86100b849 | |
| parent | 91c87416f8810bb60090baf3abd351f997e8fab4 (diff) | |
Update ReadMe (#1)
Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
| -rw-r--r-- | README.md | 17 |
1 files changed, 13 insertions, 4 deletions
@@ -1,10 +1,19 @@ -## FreeRTOS-Kernel-Partner-Supported-Ports +## FreeRTOS Partner Supported Ports -This repository is under construction. +This repository contains FreeRTOS ports supported by FreeRTOS partners. Follow +the steps below to contribute a FreeRTOS port to this repository: -## Security +1. Write the FreeRTOS port for your Compiler and Architecture. +2. Create a project in the [FreeRTOS Partner Supported Demos Repository](https://github.com/FreeRTOS/FreeRTOS-Partner-Supported-Demos/tree/main) + for your hardware for running tests as mentioned [here](https://github.com/FreeRTOS/FreeRTOS/blob/main/FreeRTOS/Demo/ThirdParty/Template/README.md). +3. Make sure all the tests pass. Add the test results in the Pull Request description. +4. Add a README file with the following information: + 1. How to use this port? + 2. Link to the test project created in Step 2. + 3. Any other relevant information. +5. Raise a PR to merge the FreeRTOS port. +6. Raise another PR to merge the test project in the [FreeRTOS-Partner-Supported-Demos Repository](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS/Demo/ThirdParty/Community-Supported). -See [CONTRIBUTING](.github/CONTRIBUTING.md#security-issue-notifications) for more information. ## License |