Update ReadMe (#1044)
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>pull/1045/head^2
parent
c31cc9ba1c
commit
278e6c4b49
@ -0,0 +1,23 @@
|
|||||||
|
## Directories:
|
||||||
|
|
||||||
|
+ The **FreeRTOS/Source** directory contains source code for some of the
|
||||||
|
FreeRTOS+ components. These subdirectories contain further readme files and
|
||||||
|
links to documentation.
|
||||||
|
|
||||||
|
+ The **FreeRTOS/Demo** directory contains a demo application for every most of
|
||||||
|
the FreeRTOS+ components. Lots of the demo applications use the FreeRTOS
|
||||||
|
Windows simulator for easy evaluation. Be aware that FreeRTOS is much slower
|
||||||
|
and not deterministic when executed in a simulated environment.
|
||||||
|
|
||||||
|
+ The **FreeRTOS/Test** directory contains tests for some of the FreeRTOS+
|
||||||
|
components. These tests verify the functional correctness of FreeRTOS+ components.
|
||||||
|
|
||||||
|
+ The **FreeRTOS-Plus/VisualStudio_StaticProjects** directory contains configuration
|
||||||
|
files and Visual Studio projects for FreeRTOS components and some third party
|
||||||
|
libraries. These projects are used by the demo applications in the
|
||||||
|
FreeRTOS-Plus/Demo directory.
|
||||||
|
|
||||||
|
+ The **FreeRTOS-Plus/ThirdParty** directory contains third party libraries used by
|
||||||
|
the demo applications in the FreeRTOS-Plus/Demo directory.
|
||||||
|
|
||||||
|
+ See http://www.freertos.org/plus
|
@ -1,13 +1,5 @@
|
|||||||
## Testing in FreeRTOS
|
|
||||||
FreeRTOS (kernel and libraries) consists of common code and porting layer. Extensive [static analysis](https://en.wikipedia.org/wiki/Static_program_analysis) and [dynamic analysis](https://en.wikipedia.org/wiki/Dynamic_program_analysis) are done on both to ensure functional correctness of FreeRTOS.
|
|
||||||
|
|
||||||
Additional bounded-ness checks are done using [CBMC](https://www.cprover.org/cbmc/). Although these checks do not cover all functions, they cover considerable chunk of code base. Missing CBMC tests will be added later.
|
|
||||||
|
|
||||||
For more information on FreeRTOS testing please refer to https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html.
|
|
||||||
|
|
||||||
## Directory structure
|
## Directory structure
|
||||||
This directory is in working progress -- we are migrating scattered test cases to this directory. Here only lists what's currently under this directory.
|
|
||||||
|
|
||||||
- ```./CBMC```: This directory contains automated proofs of the memory safety of various parts of the FreeRTOS code base.
|
- ```./CMock```: This directory has the submoduled version of CMock for providing basis for Unit testing.
|
||||||
- ```./CMock```: This directory has the submoduled version of CMock for providing basis Unit testing
|
- ```./FreeRTOS```-Cellular-Interface/Integration: This directory contains integration tests for FreeRTOS-Cellular-Interface library.
|
||||||
- ```./Unit-Tests```: This directory has the Unit tests for FreeRTOS-Plus libraries. As of now, just Unit tests for +TCP (testing these).
|
- ```./FreeRTOS-Plus```-TCP/Integration: This directory contains integration tests for FreeRTOS-Plus_TCP library.
|
||||||
|
@ -1,13 +0,0 @@
|
|||||||
Directories:
|
|
||||||
|
|
||||||
+ The FreeRTOS-Plus/Source directory contains source code for some of the
|
|
||||||
FreeRTOS+ components. These subdirectories contain further readme files and
|
|
||||||
links to documentation.
|
|
||||||
|
|
||||||
+ The FreeRTOS-Plus/Demo directory contains a demo application for every most of
|
|
||||||
the FreeRTOS+ components. Lots of the demo applications use the FreeRTOS
|
|
||||||
Windows simulator for easy evaluation. Be aware that FreeRTOS is much slower
|
|
||||||
and not deterministic when executed in a simulated environment.
|
|
||||||
|
|
||||||
+ See http://www.freertos.org/plus
|
|
||||||
|
|
Loading…
Reference in New Issue