Skip to content

Update README #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 24, 2025
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,41 @@ C++ package with SDK and examples

## Build with Visual Studio

Build RTClientSDK solution in Visual Studio 2017.
Build RTClientSDK solution in Visual Studio 2017 (or later version).

## Build with CMake (Windows & Linux)

* Tested with GCC 7.
* Tested with VS 2017.
* Tested with GCC 13.3.0
* Tested with Clang 18.1.3
* Tested with VS 2017 / MSVC 19.42

### Cloning the Repository

This project uses Git submodules. Ensure submodules are initialized after cloning:
`git clone https://github.com/qualisys/qualisys_cpp_sdk.git`

`git clone --recursive <repository-url>`
### Build As Static
```
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=STATIC && cmake --build build
```

If already cloned, initialize and update submodules:
### Build As Shared/Dynamic
```
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=SHARED && cmake --build build
```

`git submodule update --init --recursive`
### Build As Shared/Dynamic (With Versioning)
```
cmake -S . -B build -Dqualisys_cpp_sdk_OUTPUT_TYPE=SHARED_VERSIONED && cmake --build build
```

### Build Examples
```
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_EXAMPLES=ON
cmake --build build
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_EXAMPLES=ON && cmake --build build
```

### Build & Run Tests
```
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_TESTS=ON
cmake --build build
cmake -S . -B build -Dqualisys_cpp_sdk_BUILD_TESTS=ON && cmake --build build
ctest --test-dir build
```

Expand Down
Loading