Multiple tidy up and corrections preparing for release (#390)

* Update to the WolfSSL FIPS ready demo:  Add a debug break point into the configASSERT() implementation along with a comment telling users how to update the integrity check hash if they hit the breakpoint.

* Updates in the root directory:  Remove "New - Stream and Message Buffers.url" as the feature is no longer new, and edit the readme.md file as the repo now contains 'core' libraries in addition to 'FreeRTOS+' libraries.

* FreeRTOS-Plus/Source/Utilities:  Add readme files and links to documentation.

* Application-Protocols:  Add readme and URL links.

* Remove Index.html from the end of a URL in the readme.txt file.

* Demo-IP-Protocols:  Add readme.txt files and code comments saying the protocols are not intended for production use.

* coreMQTT:  Remove links to deprecated documentation, add readme and correct links to documentation.

* General:  Correct URLs in source files and .url files.

* Update readme.txt
This commit is contained in:
RichardBarry 2020-11-09 14:50:33 -08:00 committed by GitHub
parent df082944e0
commit 5d3b3cb1c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 119 additions and 42 deletions

View file

@ -0,0 +1,5 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/coremqtt

View file

@ -0,0 +1,5 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/transportinterface.html

View file

@ -0,0 +1,15 @@
The 'core' branded application protocols are 'standalone' in that they do not
have any dependencies outside of the C library. They use a simple transport
interface definition to ensure they are not dependent on the underlying TCP/IP
stack. This directory collects together the application protocols that all use
the same transport interface definition (only coreMQTT at the time of writing,
soon to also include coreHTTP).
Directories:
+ coreMQTT contains the implementation of the coreMQTT library. See:
https://www.FreeRTOS.org/coremqtt
+ network_transport contains the transport interface definition. See the
comment above and https://www.freertos.org/transportinterface.html

View file

@ -0,0 +1,5 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/logging.html

View file

@ -0,0 +1,14 @@
Directories:
+ Utilities/exponential_backoff contains a utility that calculates an
exponential back off time, with some jitter. It is used to ensure fleets of
IoT devices that become disconnected don't all try and reconnect at the same
time.
+ Utilities/logging contains header files for use with the core libraries logging
macros. See https://www.FreeRTOS.org/logging.html.
+ Utililties/mbedtls_freertos contains a few FreeRTOS specifics required by
mbedTLS.