Adding usage text

Signed-off-by: Tao He <sighingnow@gmail.com>
microsoft · Feb 6, 2023 · 1f7847c · 1f7847c
1 parent 89f721e
commit 1f7847c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/ports/etcd-cpp-apiv3/portfile.cmake b/ports/etcd-cpp-apiv3/portfile.cmake
@@ -25,3 +25,7 @@ vcpkg_copy_pdbs()
 
 # Handle copyright
 file(INSTALL ${SOURCE_PATH}/LICENSE.txt DESTINATION ${CURRENT_PACKAGES_DIR}/share/etcd-cpp-apiv3 RENAME copyright)
+
+# Adding usage text
+file(INSTALL "${CMAKE_CURRENT_LIST_DIR}/usage" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}")
+
diff --git a/ports/etcd-cpp-apiv3/usage b/ports/etcd-cpp-apiv3/usage
@@ -0,0 +1,11 @@
+The package etcd-cpp-apiv3 is compatible with built-in CMake targets:
+
+    find_package(etcd-cpp-api CONFIG REQUIRED)
+    target_link_libraries(main PRIVATE etcd-cpp-api)
+
+In cases where you only need the synchronous runtime and want to avoid the initialization
+of builtin thread pool, use:
+
+    find_package(etcd-cpp-api CONFIG REQUIRED)
+    target_link_libraries(main PRIVATE etcd-cpp-api-core)
+