Update version for release #168
Conversation
muneebahmed10
force-pushed
the
update-for-release
branch
from
a9623d0 to
b676038
Compare
muneebahmed10
force-pushed
the
update-for-release
branch
from
4f8f90f to
6325040
Compare
README.md
Outdated
| @@ -122,6 +122,13 @@ Please refer to the demos of the MQTT client library in the following locations | |||
|
|
|||
| ## Generating documentation | |||
|
|
|||
| Note: For pre-generated documentation, please see the documentation linked in the above repositories: | |||
There was a problem hiding this comment.
It may be better to have the table under a different section than "Generating Documentation" as Abhijit had mentioned that the main concern is that it makes it misleading for customers about them having to generate documentation.
If the table is present in a separate section, like "Existing Documentation", toward the beginning of the README, it would be easier for customers to notice
There was a problem hiding this comment.
How about this?
Documentation
Existing Documentation
Generating Documentation
There was a problem hiding this comment.
Yes, that's fine. These can be moved before the Unit Tests section though to make it more prominent for customers to find
| | Location | | ||
| | :-: | | ||
| | [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) | | ||
| | [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreMQTT/docs/doxygen/output/html/index.html) | |
There was a problem hiding this comment.
If the released versions of C-SDK and FreeRTOS.org don't match, it would be confusing to customers about the reason of their disparity. It would be important to add a note saying that it is possible for the C-SDK and FreeRTOS releases to contain different release versions of coreMQTT
There was a problem hiding this comment.
I added a note
Description:
Updates version number for release, and adds guards for C++ linkage. The
/* *INDENT-OFF* */is necessary for uncrustify. Also updates the documentation links to point to repositories/latest instead of specific releases, and adds a memory estimates table.The documentation link for the CSDK points to the repository's README as it aggregates links for all releases. Since the FreeRTOS/FreeRTOS repository does not, the link here points to the latest hosted documentation on freertos.org
Also updates
test/CMakeLists.txtso that tests can be built with newer C standards if specified on the command line