Skip to content

Commit 8ba1a3e

Browse files
Readme Install Instructions Update (#426)
* Updated README build from source section so it is easier to follow * Adjusted installation comments a little bit to better fit the GitHub markdown section
1 parent 73d80c9 commit 8ba1a3e

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

README.md

+35-13
Original file line numberDiff line numberDiff line change
@@ -27,45 +27,67 @@ __Jump To:__
2727

2828
### Minimum Requirements
2929
* C++ 11 or higher
30+
* Clang 3.9+ or GCC 4.8+ or MSVC 2015+
3031
* CMake 3.1+
31-
* Clang 3.9+ or GCC 4.8+ or MSVC 2015+
3232

3333
[Step-by-step instructions](./PREREQUISITES.md)
3434

3535

3636
### Build from source
3737

38-
#### Automatically Build and Install AWS Dependencies
39-
40-
Note: `-DCMAKE_INSTALL_PREFIX` can be any path where the project needs to be installed. Taking sdk-cpp-workspace as an example here.
41-
4238
#### MacOS and Linux
4339

4440
``` sh
45-
mkdir sdk-cpp-workspace
46-
cd sdk-cpp-workspace
41+
# Create a workspace directory to hold all the SDK files
42+
mkdir sdk-workspace
43+
cd sdk-workspace
44+
# Clone the repository
4745
git clone --recursive https://github.com/aws/aws-iot-device-sdk-cpp-v2.git
46+
# Ensure all submodules are properly updated
47+
cd aws-iot-device-sdk-cpp-v2
48+
git submodule update --init --recursive
49+
cd ..
50+
# Make a build directory for the SDK. Can use any name.
51+
# If working with multiple SDKs, using a SDK-specific name is helpful.
4852
mkdir aws-iot-device-sdk-cpp-v2-build
4953
cd aws-iot-device-sdk-cpp-v2-build
50-
cmake -DCMAKE_INSTALL_PREFIX="<absolute path sdk-cpp-workspace dir>" -DCMAKE_BUILD_TYPE="<Release|RelWithDebInfo|Debug>" ../aws-iot-device-sdk-cpp-v2
54+
# Generate the SDK build files.
55+
# -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory.
56+
# (Example: "/Users/example/sdk-workspace/).
57+
# -DCMAKE_BUILD_TYPE can be "Release", "RelWithDebInfo", or "Debug"
58+
cmake -DCMAKE_INSTALL_PREFIX="<absolute path to sdk-workspace>" -DCMAKE_BUILD_TYPE="Debug" ../aws-iot-device-sdk-cpp-v2
59+
# Build and install the library. Once installed, you can develop with the SDK and run the samples
5160
cmake --build . --target install
5261
```
5362

5463
#### Windows
5564

5665
``` sh
57-
mkdir sdk-cpp-workspace
66+
# Create a workspace directory to hold all the SDK files
67+
mkdir sdk-workspace
5868
cd sdk-cpp-workspace
69+
# Clone the repository
5970
git clone --recursive https://github.com/aws/aws-iot-device-sdk-cpp-v2.git
71+
# Ensure all submodules are properly updated
72+
cd aws-iot-device-sdk-cpp-v2
73+
git submodule update --init --recursive
74+
cd ..
75+
# Make a build directory for the SDK. Can use any name.
76+
# If working with multiple SDKs, using a SDK-specific name is helpful.
6077
mkdir aws-iot-device-sdk-cpp-v2-build
6178
cd aws-iot-device-sdk-cpp-v2-build
79+
# Generate the SDK build files.
80+
# -DCMAKE_INSTALL_PREFIX needs to be the absolute/full path to the directory.
81+
# (Example: "C:/users/example/sdk-workspace/).
6282
cmake -DCMAKE_INSTALL_PREFIX="<absolute path sdk-cpp-workspace dir>" ../aws-iot-device-sdk-cpp-v2
63-
cmake --build . --target install --config "<Release|RelWithDebInfo|Debug>"
83+
# Build and install the library. Once installed, you can develop with the SDK and run the samples
84+
# -config can be "Release", "RelWithDebInfo", or "Debug"
85+
cmake --build . --target install --config "Debug"
6486
```
6587

66-
Due to maximum path length limitations in the Windows API, we recommend cloning to a short path like: `C:\dev\iotsdk`
67-
68-
`--config` is only REQUIRED for multi-configuration build tools (VisualStudio/MsBuild being the most common).
88+
**Windows specific notes**:
89+
* Due to maximum path length limitations in the Windows API, we recommend cloning to a short path like: `C:\dev\iotsdk`
90+
* `--config` is only REQUIRED for multi-configuration build tools (VisualStudio/MsBuild being the most common).
6991

7092
## Samples
7193

0 commit comments

Comments
 (0)