Skip to content

Commit b53e6e5

Browse files
Update README.md (#15)
* Update README.md * Updated the File after @gitwallit's comments
1 parent eea2edf commit b53e6e5

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@ Additionally, for FreeRTOS-Plus-TCP source code organization refer to the [Docum
66
### Getting help
77
If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). Please also refer to [FAQ](http://www.freertos.org/FAQHelp.html) for frequently asked questions.
88

9+
Also see the [Submitting a bugs/feature request](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/master/CONTRIBUTING.md#submitting-a-bugsfeature-request) section of CONTRIBUTING.md for more details.
10+
911
## Cloning this repository
10-
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
12+
This repository uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
1113

1214
Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid Git repository)
1315

1416
To clone using HTTPS:
1517
```
16-
git clone https://github.com/FreeRTOS/FreeRTOS-Plus-TCP.git --recurse-submodules
18+
git clone https://github.com/FreeRTOS/FreeRTOS-Plus-TCP.git
1719
git submodule update --checkout --init --recursive tools/CMock test/FreeRTOS-Kernel
1820
```
1921
Using SSH:
2022
```
21-
git clone [email protected]:FreeRTOS/FreeRTOS-Plus-TCP.git --recurse-submodules
23+
git clone [email protected]:FreeRTOS/FreeRTOS-Plus-TCP.git
2224
git submodule update --checkout --init --recursive tools/CMock test/FreeRTOS-Kernel
2325
```
2426

@@ -27,6 +29,15 @@ The porting guide is available on [this page](http://www.FreeRTOS.org/FreeRTOS-P
2729

2830
## Repository structure
2931
This repository contains the FreeRTOS-Plus-TCP repository and a number of supplementary libraries for testing/PR Checks.
32+
Below is the breakdown of what each directory contains:
33+
- tools
34+
- This directory contains the tools and related files (CMock/uncrustify) required to run tests/checks on the TCP source code.
35+
- tests
36+
- This directory contains all the tests (unit tests and CBMC) and the dependencies ([FreeRTOS-Kernel](https://github.com/FreeRTOS/FreeRTOS-Kernel)/[Litani-port](https://github.com/awslabs/aws-build-accumulator)) the tests require.
37+
- portable
38+
- This directory contains the portable files required to compile the FreeRTOS-Plus-TCP source code for different hardware/compilers.
39+
- include
40+
- The include directory has all the 'core' header files of FreeRTOS-Plus-TCP source.
3041

3142
## Note
3243
At this time it is recommended to use BufferAllocation_2.c in which case it is essential to use the heap_4.c memory allocation scheme. See [memory management](http://www.FreeRTOS.org/a00111.html).

0 commit comments

Comments
 (0)