Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #15

Merged
merged 2 commits into from
Oct 5, 2020
Merged

Update README.md #15

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d49211e
Update README.md
AniruddhaKanhere Oct 2, 2020
6572e7f
Updated the File after @gitwallit's comments
AniruddhaKanhere Oct 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,21 @@ Additionally, for FreeRTOS-Plus-TCP source code organization refer to the [Docum
### Getting help
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.

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.

## Cloning this repository
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
This repository uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.

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)

To clone using HTTPS:
```
git clone https://github.com/FreeRTOS/FreeRTOS-Plus-TCP.git --recurse-submodules
git clone https://github.com/FreeRTOS/FreeRTOS-Plus-TCP.git
git submodule update --checkout --init --recursive tools/CMock test/FreeRTOS-Kernel
```
Using SSH:
```
git clone git@github.com:FreeRTOS/FreeRTOS-Plus-TCP.git --recurse-submodules
git clone git@github.com:FreeRTOS/FreeRTOS-Plus-TCP.git
git submodule update --checkout --init --recursive tools/CMock test/FreeRTOS-Kernel
```

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

## Repository structure
This repository contains the FreeRTOS-Plus-TCP repository and a number of supplementary libraries for testing/PR Checks.
Below is the breakdown of what each directory contains:
- tools
- This directory contains the tools and related files (CMock/uncrustify) required for tests/checks for the TCP source code.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor correction in grammar "This directory contains the tools and related files (CMock/uncrustify) required to run tests/checks on the TCP source code"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gitwallit, I have updated the readme file.
Can you please re-review it?

- tests
- 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.
- portable
- This directory contains the portable files required to compile the FreeRTOS-Plus-TCP source code for different hardwares/compilers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hardware, instead of hardwares

- include
- The include directory has all 'core' the header files of FreeRTOS-Plus-TCP source.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

has all the 'core' header files of the FreeRTOS-PLUS-TCP source

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! What was I thinking... Have updated the language.


## Note
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).
Expand Down