summaryrefslogtreecommitdiff
path: root/protocols/Telegram/tdlib/td/example/cpp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'protocols/Telegram/tdlib/td/example/cpp/README.md')
-rw-r--r--protocols/Telegram/tdlib/td/example/cpp/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/protocols/Telegram/tdlib/td/example/cpp/README.md b/protocols/Telegram/tdlib/td/example/cpp/README.md
new file mode 100644
index 0000000000..9e5de531ba
--- /dev/null
+++ b/protocols/Telegram/tdlib/td/example/cpp/README.md
@@ -0,0 +1,24 @@
+# TDLib cpp basic usage examples
+
+TDLib should be prebuilt and installed to local subdirectory `td/`:
+```
+cd <path to TDLib sources>
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../example/cpp/td ..
+cmake --build . --target install
+```
+Also see [building](https://github.com/tdlib/td#building) for additional details on TDLib building.
+
+Then you can build the examples:
+```
+cd <path to TDLib sources>/example/cpp
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DTd_DIR=<full path to TDLib sources>/example/cpp/td/lib/cmake/Td ..
+cmake --build .
+```
+
+Documentation for all available classes and methods can be found at https://core.telegram.org/tdlib/docs.
+
+To run `tdjson_example` you may need to manually copy a `tdjson` shared library from `td/bin` to a directory containing built binaries.