Skip to content
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.

Sign up for GitHub

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

Update information about submodules #29

Merged
merged 1 commit into from
Nov 26, 2023
Merged

Update information about submodules #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,20 @@ The library is being renamed from GitHub_API to cpp_RestAPI.
At this moment, to provide backward compatibility, old interfaces are still available but are about to be removed.
Do not use classes marked as deprecated in new projects.

# Submodules

This repository has submodules which are not necessary to build and use this project.<br>
You may need them if you want to build unit tests (`GitHubAPI_Tests` cmake varible set to `TRUE`).<br><br>
Another submodule is `vcpkg` which can simplify build by providing required dependencies.<br>
Please mind that vcpkg uses **telemetry**.<br>
Look here for more details: https://learn.microsoft.com/vcpkg/about/privacy

## How to use it

This is a CMake based project and is meant to be included as a subproject.

Simply embed cpp_restapi's sources in your project,
choose which http backend you prefer (both can be used simoultanously) and include cpp_restapi project in your CMakeLists.txt like this:
choose which http backend you prefer (both can be used simoultanously) and include `cpp_restapi` project in your `CMakeLists.txt` like this:

```cmake
set(GitHubAPI_QtBackend ON) # use this line if you prefer Qt backend
Expand All @@ -40,7 +48,7 @@ and that's all.
Depending on your choice of backend you may need to install libcurl and/or Qt libraries.

Qt backend can be compiled with Qt5 (default) or Qt6.
Set GitHubAPI_UseQt6 CMake variable to TRUE to use Qt6.
Set `GitHubAPI_UseQt6` CMake variable to `TRUE` to use Qt6.


## Examples
Expand Down
Loading