Skip to content

Commit bf0570a

Browse files
Initial update of the README.md file.
1 parent bd7819f commit bf0570a

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,39 @@ Build RTClientSDK solution in Visual Studio 2017.
88

99
## Build with CMake (Windows & Linux)
1010

11-
* Tested with GCC 7.
12-
* Tested with VS 2017.
11+
* Tested with GCC 13.3.0
12+
* Tested with Clang 18.1.3
13+
* Tested with VS 2017 / MSVC 19.42
1314

1415
### Cloning the Repository
1516

1617
This project uses Git submodules. Ensure submodules are initialized after cloning:
1718

18-
`git clone --recursive <repository-url>`
19+
`git clone <repository-url>`
1920

20-
If already cloned, initialize and update submodules:
21+
### Build As Static
22+
```
23+
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=STATIC && cmake --build build
24+
```
2125

22-
`git submodule update --init --recursive`
26+
### Build As Shared/Dynamic
27+
```
28+
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=SHARED && cmake --build build
29+
```
30+
31+
### Build As Shared/Dynamic (With Versioning)
32+
```
33+
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=SHARED_VERSIONED && cmake --build build
34+
```
2335

2436
### Build Examples
2537
```
26-
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_EXAMPLES=ON
27-
cmake --build build
38+
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_EXAMPLES=ON && cmake --build build
2839
```
2940

3041
### Build & Run Tests
3142
```
32-
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_TESTS=ON
33-
cmake --build build
43+
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_TESTS=ON && cmake --build build
3444
ctest --test-dir build
3545
```
3646

0 commit comments

Comments
 (0)