diff --git a/README.md b/README.md index be44cd5c2..4976921fd 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,6 @@ # AWS IoT Device SDK for C++ v2 -This document provides information about the AWS IoT device SDK for C++ V2. - -If you have any issues or feature requests, please file an issue or pull request. - -This SDK is built on the AWS Common Runtime, a collection of libraries -([aws-c-common](https://github.com/awslabs/aws-c-common), -[aws-c-io](https://github.com/awslabs/aws-c-io), -[aws-c-mqtt](https://github.com/awslabs/aws-c-mqtt), -[aws-c-http](https://github.com/awslabs/aws-c-http), -[aws-c-cal](https://github.com/awslabs/aws-c-cal), -[aws-c-auth](https://github.com/awslabs/aws-c-auth), -[s2n](https://github.com/awslabs/s2n)...) written in C to be -cross-platform, high-performance, secure, and reliable. The libraries are bound -to C++ by the [aws-crt-cpp](https://github.com/awslabs/aws-crt-cpp) package. +This document provides information about the AWS IoT device SDK for C++ V2. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html) __Jump To:__ @@ -21,9 +8,8 @@ __Jump To:__ * [Samples](./samples) * [Getting Help](#getting-help) * [FAQ](./documents/FAQ.md) -* [Giving Feedback and Contributions](#giving-feedback-and-contributions) +* [API Docs](https://aws.github.io/aws-iot-device-sdk-cpp-v2/) * [MQTT5 User Guide](./documents/MQTT5_Userguide.md) -* [Secure Tunnel User Guide](./documents/Secure_Tunnel_Userguide.md) ## Installation @@ -38,22 +24,20 @@ __Jump To:__ ### Build from source -#### MacOS and Linux - ``` sh # Create a workspace directory to hold all the SDK files mkdir sdk-workspace cd sdk-workspace # Clone the repository git clone --recursive https://github.com/aws/aws-iot-device-sdk-cpp-v2.git -# Ensure all submodules are properly updated -cd aws-iot-device-sdk-cpp-v2 -git submodule update --init --recursive -cd .. # Make a build directory for the SDK. Can use any name. -# If working with multiple SDKs, using a SDK-specific name is helpful. mkdir aws-iot-device-sdk-cpp-v2-build cd aws-iot-device-sdk-cpp-v2-build +# continue with the build steps below based on OS +``` + +#### MacOS and Linux +```sh # Generate the SDK build files. # -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory. # (Example: "/Users/example/sdk-workspace/). @@ -64,25 +48,11 @@ cmake --build . --target install ``` #### Windows - ``` sh -# Create a workspace directory to hold all the SDK files -mkdir sdk-workspace -cd sdk-cpp-workspace -# Clone the repository -git clone --recursive https://github.com/aws/aws-iot-device-sdk-cpp-v2.git -# Ensure all submodules are properly updated -cd aws-iot-device-sdk-cpp-v2 -git submodule update --init --recursive -cd .. -# Make a build directory for the SDK. Can use any name. -# If working with multiple SDKs, using a SDK-specific name is helpful. -mkdir aws-iot-device-sdk-cpp-v2-build -cd aws-iot-device-sdk-cpp-v2-build # Generate the SDK build files. # -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory. # (Example: "C:/users/example/sdk-workspace/). -cmake -DCMAKE_INSTALL_PREFIX="" ../aws-iot-device-sdk-cpp-v2 +cmake -DCMAKE_INSTALL_PREFIX="" ../aws-iot-device-sdk-cpp-v2 # Build and install the library. Once installed, you can develop with the SDK and run the samples # -config can be "Release", "RelWithDebInfo", or "Debug" cmake --build . --target install --config "Debug" @@ -115,13 +85,13 @@ existing `libcrypto`, instead of building its own copy. ## Getting Help -The best way to interact with our team is through GitHub. You can [open an issue](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues) and choose from one of our templates for guidance, bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag #aws-iot or If you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case. +The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-cpp-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues/new/choose) for bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag [#aws-iot](https://stackoverflow.com/questions/tagged/aws-iot) or if you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case. Please make sure to check out our resources too before opening an issue: -* Our [FAQ](./documents/FAQ.md) +* [FAQ](./documents/FAQ.md) * [API Docs](https://aws.github.io/aws-iot-device-sdk-cpp-v2/) -* Our [Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs)) +* [IoT Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs)) * Check for similar [Issues](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues) * [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/) * [Dev Blog](https://aws.amazon.com/blogs/?awsf.blog-master-iot=category-internet-of-things%23amazon-freertos%7Ccategory-internet-of-things%23aws-greengrass%7Ccategory-internet-of-things%23aws-iot-analytics%7Ccategory-internet-of-things%23aws-iot-button%7Ccategory-internet-of-things%23aws-iot-device-defender%7Ccategory-internet-of-things%23aws-iot-device-management%7Ccategory-internet-of-things%23aws-iot-platform) @@ -129,15 +99,8 @@ Please make sure to check out our resources too before opening an issue: [Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) and [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) is provided by code that been generated from a model of the service. - -## Giving Feedback and Contributions - -We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels. - +* [Secure Tunnel User Guide](./documents/Secure_Tunnel_Userguide.md) * [Contributions Guidelines](./documents/CONTRIBUTING.md) -* Articulate your feature request or upvote existing ones on our [Issues](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request) page. -* Create discussion questions [here](https://github.com/aws/aws-iot-device-sdk-cpp-v2/discussions) -* Find a bug open an [issue](https://github.com/aws/aws-iot-device-sdk-cpp-v2/issues) ## License