Better build/dependencies documentation

aneoconsulting · Sep 13, 2023 · 8a3b3ad · 8a3b3ad
1 parent 46d20b2
commit 8a3b3ad
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 53 deletions.
diff --git a/packages/cpp/ArmoniK.Api.Common/CMakeLists.txt b/packages/cpp/ArmoniK.Api.Common/CMakeLists.txt
@@ -39,7 +39,7 @@ include(FetchContent)
 
 FETCHCONTENT_DECLARE(
         fmt
-        URL ${SRC_FMT}
+        URL "${SRC_FMT}"
         TIMEOUT 180
 )
 

diff --git a/packages/cpp/ArmoniK.Api.Tests/CMakeLists.txt b/packages/cpp/ArmoniK.Api.Tests/CMakeLists.txt
@@ -45,7 +45,7 @@ set_property(TARGET ${PROJECT_NAME} APPEND PROPERTY
 include(FetchContent)
 FetchContent_Declare(
     googletest
-    URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip
+    URL "${SRC_GTEST}"
 )
 # For Windows: Prevent overriding the parent project's compiler/linker settings
 set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)

diff --git a/packages/cpp/README.md b/packages/cpp/README.md
@@ -0,0 +1,17 @@
+# ArmoniK Api Cpp
+
+## Build requirements
+- cmake 3.22+
+- C++ compiler with C++17 support
+- grpc 1.54 - 1.56.2
+- protobuf
+- fmt 10.1.0 (https://github.com/fmtlib/fmt/archive/refs/tags/10.1.0.tar.gz)
+- simdjson 3.2.2 (https://github.com/simdjson/simdjson/archive/refs/tags/v3.2.2.tar.gz)
+- gtest (https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip) (if BUILD_TEST=ON)
+
+## How to build
+```shell
+cmake -S . -B out
+cmake --build out
+cmake --install out
+```
diff --git a/packages/cpp/cmake/downloader.cmake b/packages/cpp/cmake/downloader.cmake
diff --git a/packages/cpp/cmake/downloader.ps1 b/packages/cpp/cmake/downloader.ps1