aboutsummaryrefslogtreecommitdiff
path: root/ports/promise-cpp/usage
diff options
context:
space:
mode:
Diffstat (limited to 'ports/promise-cpp/usage')
-rw-r--r--ports/promise-cpp/usage9
1 files changed, 9 insertions, 0 deletions
diff --git a/ports/promise-cpp/usage b/ports/promise-cpp/usage
new file mode 100644
index 000000000..0e9d48636
--- /dev/null
+++ b/ports/promise-cpp/usage
@@ -0,0 +1,9 @@
+The package promise-cpp is header only and can be used from CMake via:
+
+ find_path(PROMISE_CPP_INCLUDE_DIRS "promise-cpp/promise.hpp")
+ target_include_directories(main PRIVATE ${PROMISE_CPP_INCLUDE_DIRS})
+
+Make sure to define the pre-processor macro PROMISE_HEADONLY before including "promise-cpp/promise.hpp":
+
+ #define PROMISE_HEADONLY
+ #include "promise-cpp/promise.hpp" \ No newline at end of file