summaryrefslogtreecommitdiff
path: root/include/tgbot/tgbot.h
diff options
context:
space:
mode:
authorOleg Morozenkov <reo7sp@users.noreply.github.com>2017-01-26 14:31:14 +0300
committerOleg Morozenkov <reo7sp@users.noreply.github.com>2017-01-26 14:31:14 +0300
commit2e6a6072e81a1845e7365e5f2dcd10cc9cb8ff56 (patch)
treeaeaed6f544ee56b6e38a6963a40d1809769fc1a5 /include/tgbot/tgbot.h
parentbf0d39d4aae287306daa1ed13182926a373e3e41 (diff)
Bot compilation instructions in README. Update docs
Diffstat (limited to 'include/tgbot/tgbot.h')
-rw-r--r--include/tgbot/tgbot.h14
1 files changed, 11 insertions, 3 deletions
diff --git a/include/tgbot/tgbot.h b/include/tgbot/tgbot.h
index a7c8ae6..b9d93c3 100644
--- a/include/tgbot/tgbot.h
+++ b/include/tgbot/tgbot.h
@@ -72,8 +72,9 @@
* @defgroup tools
*
* @mainpage
+ * [Go to GitHub](https://github.com/reo7sp)
*
- * @section Compilation
+ * @section lib_compile Library compilation
*
* Firstly you need to install some dependencies such as Boost and build tools such as CMake. On Debian-based distibutives you can do it with these commands:
* @code{.sh}
@@ -88,9 +89,16 @@
* sudo make install
* @endcode
*
- * That's all. All you have to do now is just link compiled library to your project.
+ * @section bot_compile Bot compilation
+ * With CMake:
+ * [Example CMakeLists.txt](samples/echobot/CMakeLists.txt)
*
- * If you want, you can also use Docker to build and run your bot. Just set the base image of your's Dockerfile to reo7sp/tgbot-cpp.
+ * Without CMake:
+ * @code{.sh}
+ * g++ telegram_bot.cpp -o telegram_bot --std=c++11 -I/usr/local/include -lTgBot -lboost_system -lboost_iostreams -lssl -lcrypto -lpthread
+ * @endcode
+ *
+ * You can use Docker to build and run your bot. Set the base image of your's Dockerfile to [reo7sp/tgbot-cpp](https://hub.docker.com/r/reo7sp/tgbot-cpp/).
*
* @section Samples
* All samples are located [here](https://github.com/reo7sp/tgbot-cpp/tree/master/samples)