README.md updated for V3.0.0 #524
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
AniruddhaKanhere
left a comment
AniruddhaKanhere
left a comment
There was a problem hiding this comment.
Thanks @gitwallit for this PR.
I have a few comments/suggestions. Can you please take a look?
Co-authored-by: Aniruddha Kanhere <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>
AniruddhaKanhere
previously approved these changes
Jul 25, 2022
paulbartell
previously approved these changes
Jul 26, 2022
tanmoysen
reviewed
Jul 26, 2022
README.md
Outdated
| Also see the [Submitting a bugs/feature request](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/.github/CONTRIBUTING.md#submitting-a-bugsfeature-request) section of CONTRIBUTING.md for more details. | ||
|
|
||
| ## Updating to V3.0.0 and above | ||
| In versions >= 3.0.0, the folder structure of FreeRTOS-Plus-TCP has changed and the files have been broken down into smaller logically separated modules. This change makes the code more modular and conducive to unit-tests. Additionally, the source files have been moved to a `source` directory. This change requires modification of any existing project(s) to include the modified source files and directories. There are examples on how to use the new files and directory structure. For a windows simulator based example, refer to this [demo](https://github.com/FreeRTOS/FreeRTOS/tree/TCPRefactorDemo/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator). For an example based on the Xilinx Zynq-7000, use the code in this [branch](https://github.com/aws/amazon-freertos/tree/TCPRefactorDemo) and follow these [instructions](https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_xilinx.html) to build and run the demo. |
There was a problem hiding this comment.
I'd suggest we add a section introducing v3.0.0.
"FreeRTOS-Plus-TCP V3.0.0 improves the robustness, security, and modularity of the library. FreeRTOS-Plus-TCP V3.0.0 adds comprehensive unit test coverage for all lines and branches of code, and has undergone penetration testing and protocol testing by AWS Security to reduce the exposure to security vulnerabilities. For context, protocol testing involves compliance and impairment checks for IPV4, TCP, UDP, DHCP, ARP and ICMP, which helps improve the robustness of FreeRTOS-Plus-TCP TCP/IP stack."
Contributor
Author
There was a problem hiding this comment.
I've added a link to the blog.
tanmoysen
reviewed
Jul 26, 2022
README.md
Outdated
| Also see the [Submitting a bugs/feature request](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/.github/CONTRIBUTING.md#submitting-a-bugsfeature-request) section of CONTRIBUTING.md for more details. | ||
|
|
||
| ## Updating to V3.0.0 and above | ||
| In versions >= 3.0.0, the folder structure of FreeRTOS-Plus-TCP has changed and the files have been broken down into smaller logically separated modules. This change makes the code more modular and conducive to unit-tests. Additionally, the source files have been moved to a `source` directory. This change requires modification of any existing project(s) to include the modified source files and directories. There are examples on how to use the new files and directory structure. For a windows simulator based example, refer to this [demo](https://github.com/FreeRTOS/FreeRTOS/tree/TCPRefactorDemo/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator). For an example based on the Xilinx Zynq-7000, use the code in this [branch](https://github.com/aws/amazon-freertos/tree/TCPRefactorDemo) and follow these [instructions](https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_xilinx.html) to build and run the demo. |
There was a problem hiding this comment.
In versions 3.0.0 or higher, the folder structure.....
tanmoysen
reviewed
Jul 26, 2022
README.md
Outdated
| In versions >= 3.0.0, the folder structure of FreeRTOS-Plus-TCP has changed and the files have been broken down into smaller logically separated modules. This change makes the code more modular and conducive to unit-tests. Additionally, the source files have been moved to a `source` directory. This change requires modification of any existing project(s) to include the modified source files and directories. There are examples on how to use the new files and directory structure. For a windows simulator based example, refer to this [demo](https://github.com/FreeRTOS/FreeRTOS/tree/TCPRefactorDemo/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator). For an example based on the Xilinx Zynq-7000, use the code in this [branch](https://github.com/aws/amazon-freertos/tree/TCPRefactorDemo) and follow these [instructions](https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_xilinx.html) to build and run the demo. | ||
|
|
||
| ### Generating pre V3.0.0 folder structure for backward compatibility: | ||
| If you wish to continue using a version earlier than V3.0.0 i.e. continue with use of the older source code organization, a script is provided to generate the folder structure similar to [this](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/tree/f118c8415b4373e3d6e6dbd2d5a116f7eaf27b63). |
There was a problem hiding this comment.
"If you wish to continue using a version earlier than V3.0.0 i.e. continue to use your existing source code organization....
gitwallit
dismissed stale reviews from paulbartell and AniruddhaKanhere
via
ea33a35
tanmoysen
reviewed
Jul 27, 2022
README.md
Outdated
| Also see the [Submitting a bugs/feature request](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/.github/CONTRIBUTING.md#submitting-a-bugsfeature-request) section of CONTRIBUTING.md for more details. | ||
|
|
||
| ## Upgrading to V3.0.0 and above | ||
| In version 3.0.0 or higher, the folder structure of FreeRTOS-Plus-TCP has changed and the files have been broken down into smaller logically separated modules. This change makes the code more modular and conducive to unit-tests. Learn more about the V3.0.0 release [here](https://freertos.org/2022/07/the-freertos-plus-tcp-library-is-now-more-robust-and-secure.html). Additionally, the source files have been moved to a `source` directory. This change requires modification of any existing project(s) to include the modified source files and directories. There are examples on how to use the new files and directory structure. For a windows simulator based example, refer to this [demo](https://github.com/FreeRTOS/FreeRTOS/tree/TCPRefactorDemo/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_Minimal_Windows_Simulator). For an example based on the Xilinx Zynq-7000, use the code in this [branch](https://github.com/aws/amazon-freertos/tree/TCPRefactorDemo) and follow these [instructions](https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_xilinx.html) to build and run the demo. |
There was a problem hiding this comment.
Pointing to the blog will worsen the user journey (back'n'forth from the blog README.) Instead, we can add a few lines to this section. Example:
"FreeRTOS-Plus-TCP V3.0.0 improves the robustness, security, and modularity of the library. FreeRTOS-Plus-TCP V3.0.0 adds comprehensive unit test coverage for all lines and branches of code, and has undergone penetration testing and protocol testing by AWS Security to reduce the exposure to security vulnerabilities. For context, protocol testing involves compliance and impairment checks for IPV4, TCP, UDP, DHCP, ARP and ICMP, which helps improve the robustness of FreeRTOS-Plus-TCP TCP/IP stack."
tanmoysen
approved these changes
Jul 28, 2022
AniruddhaKanhere
approved these changes
Jul 28, 2022
n9wxu
approved these changes
Aug 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated README.md by adding an introduction to FreeRTOS-Plus-TCP and moving the upgrading to V3.0.0 section to below the introduction and getting started sections (as recommended).