From 164a37e2d73d62fcb57e7d5ceba08ab5a1d58cf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Walenciak?= Date: Sun, 26 Nov 2023 13:52:34 +0100 Subject: [PATCH] Update information about submodules --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4823e58..4a9d86e 100644 --- a/README.md +++ b/README.md @@ -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.
+You may need them if you want to build unit tests (`GitHubAPI_Tests` cmake varible set to `TRUE`).

+Another submodule is `vcpkg` which can simplify build by providing required dependencies.
+Please mind that vcpkg uses **telemetry**.
+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 @@ -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