Merge pull request #1 from aggarg/port_contrib

Update ReadMe

1 files changed, 13 insertions, 5 deletions

diff --git a/README.md b/README.md
index deec20c..209ffc3 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,18 @@
-## FreeRTOS-Kernel-Community-Supported-Ports
+## FreeRTOS Community Supported Ports
 
-This repository is under construction.
+This repository contains FreeRTOS ports supported by FreeRTOS community members.
+Follow the steps below to contribute a FreeRTOS port to this repository:
 
-## Security
-
-See [CONTRIBUTING](.github/CONTRIBUTING.md#security-issue-notifications) for more information.
+1. Write FreeRTOS port for your Compiler and Architecture.
+2. *[Optional]* Create a project in the [FreeRTOS Community Supported Demos Repository](https://github.com/FreeRTOS/FreeRTOS-Community-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. *[Optional]* 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. *[Optional]* Link to the test project created in Step 2.
+    3. Any other relevant information.
+5. Raise a pull request to merge the port.
+6. *[Optional]* Raise another PR to merge the test project in the [FreeRTOS Partner Supported Demos Repository](https://github.com/FreeRTOS/FreeRTOS-Partner-Supported-Demos/tree/main).
 
 ## License