You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,21 @@ Additionally, for FreeRTOS-Plus-TCP source code organization refer to the [Docum
6
6
### Getting help
7
7
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.
8
8
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
+
9
11
## 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.
11
13
12
14
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)
@@ -27,6 +29,15 @@ The porting guide is available on [this page](http://www.FreeRTOS.org/FreeRTOS-P
27
29
28
30
## Repository structure
29
31
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.
30
41
31
42
## Note
32
43
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