Update the README file

FreeRTOS · Sep 2, 2023 · 4014964 · 4014964
1 parent 40604c4
commit 4014964
Showing 1 changed file with 60 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,43 +1,57 @@
 # coreHTTP Client Library
 
+**[API Documentation Pages for current and previous releases of this library can be found here](https://freertos.github.io/coreHTTP/)**
+
+
 This repository contains a C language HTTP client library designed for embedded
 platforms. It has no dependencies on any additional libraries other than the
-standard C library, [llhttp](https://github.com/nodejs/llhttp), and
-a customer-implemented transport interface. This library is distributed under
-the [MIT Open Source License](LICENSE).
+standard C library, [llhttp](https://github.com/nodejs/llhttp), and a
+customer-implemented transport interface. This library is distributed under the
+[MIT Open Source License](LICENSE).
 
 This library has gone through code quality checks including verification that no
-function has a [GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html)
+function has a
+[GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html)
 score over 8. This library has also undergone both static code analysis from
 [Coverity static analysis](https://scan.coverity.com/), and validation of memory
 safety and data structure invariance through the
 [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
 
-See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
+See memory requirements for this library
+[here](./docs/doxygen/include/size_table.md).
 
-**coreHTTP v3.0.0 [source code](https://github.com/FreeRTOS/coreHTTP/tree/v3.0.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.**
+**coreHTTP v3.0.0
+[source code](https://github.com/FreeRTOS/coreHTTP/tree/v3.0.0/source) is part
+of the
+[FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS)
+release.**
 
-**coreHTTP v2.0.0 [source code](https://github.com/FreeRTOS/coreHTTP/tree/v2.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
+**coreHTTP v2.0.0
+[source code](https://github.com/FreeRTOS/coreHTTP/tree/v2.0.0/source) is part
+of the
+[FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS)
+release.**
 
 ## coreHTTP Config File
 
 The HTTP client library exposes configuration macros that are required for
 building the library. A list of all the configurations and their default values
-are defined in [core_http_config_defaults.h](source/include/core_http_config_defaults.h).
-To provide custom values for the configuration macros, a custom config file
-named `core_http_config.h` can be provided by the user application to the library.
+are defined in
+[core_http_config_defaults.h](source/include/core_http_config_defaults.h). To
+provide custom values for the configuration macros, a custom config file named
+`core_http_config.h` can be provided by the user application to the library.
 
 By default, a `core_http_config.h` custom config is required to build the
 library. To disable this requirement and build the library with default
 configuration values, provide `HTTP_DO_NOT_USE_CUSTOM_CONFIG` as a compile time
 preprocessor macro.
 
 **The HTTP client library can be built by either**:
-* Defining a `core_http_config.h` file in the application, and adding it to the
-include directories for the library build.
-**OR**
-* Defining the `HTTP_DO_NOT_USE_CUSTOM_CONFIG` preprocessor macro for the
-library build.
+
+- Defining a `core_http_config.h` file in the application, and adding it to the
+  include directories for the library build. **OR**
+- Defining the `HTTP_DO_NOT_USE_CUSTOM_CONFIG` preprocessor macro for the
+  library build.
 
 ## Building the Library
 
@@ -58,19 +72,20 @@ file, refer to the `coverity_analysis` library target in
 ### Platform Prerequisites
 
 - For running unit tests, the following are required:
-    - **C90 compiler** like gcc
-    - **CMake 3.13.0 or later**
-    - **Ruby 2.0.0 or later** is required for this repository's
-      [CMock test framework](https://github.com/ThrowTheSwitch/CMock).
+  - **C90 compiler** like gcc
+  - **CMake 3.13.0 or later**
+  - **Ruby 2.0.0 or later** is required for this repository's
+    [CMock test framework](https://github.com/ThrowTheSwitch/CMock).
 - For running the coverage target, the following are required:
-    - **gcov**
-    - **lcov**
+  - **gcov**
+  - **lcov**
 
 ### Steps to build **Unit Tests**
 
 1. Go to the root directory of this repository.
 
-1. Run the *cmake* command: `cmake -S test -B build -DBUILD_CLONE_SUBMODULES=ON `
+1. Run the _cmake_ command:
+   `cmake -S test -B build -DBUILD_CLONE_SUBMODULES=ON `
 
 1. Run this command to build the library and unit tests: `make -C build all`
 
@@ -80,38 +95,49 @@ file, refer to the `coverity_analysis` library target in
 
 ## CBMC
 
- To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training).
+To learn more about CBMC and proofs specifically, review the training material
+[here](https://model-checking.github.io/cbmc-training).
 
 The `test/cbmc/proofs` directory contains CBMC proofs.
 
-In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html).
+In order to run these proofs you will need to install CBMC and other tools by
+following the instructions
+[here](https://model-checking.github.io/cbmc-training/installation.html).
 
 ## Reference examples
 
-The AWS IoT Device SDK for Embedded C repository contains demos of using the HTTP client
-library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/http)
-on a POSIX platform. These can be used as reference examples for the library API.
+The AWS IoT Device SDK for Embedded C repository contains demos of using the
+HTTP client library
+[here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/http)
+on a POSIX platform. These can be used as reference examples for the library
+API.
 
 ## Documentation
 
 ### Existing Documentation
-For pre-generated documentation, please see the documentation linked in the locations below:
 
-| Location |
-| :-: |
+For pre-generated documentation, please see the documentation linked in the
+locations below:
+
+|                                                       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/coreHTTP/docs/doxygen/output/html/index.html) |
+|       [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreHTTP/docs/doxygen/output/html/index.html)        |
 
-Note that the latest included version of coreHTTP may differ across repositories.
+Note that the latest included version of coreHTTP may differ across
+repositories.
 
 ### Generating Documentation
+
 The Doxygen references were created using Doxygen version 1.9.2. To generate the
-Doxygen pages, please run the following command from the root of this repository:
+Doxygen pages, please run the following command from the root of this
+repository:
 
 ```shell
 doxygen docs/doxygen/config.doxyfile
 ```
 
 ## Contributing
 
-See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing.
+See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on
+contributing.