1 files changed, 89 insertions, 0 deletions
diff --git a/include/tgbot/doxygenMain.h b/include/tgbot/doxygenMain.h
new file mode 100644
index 0000000..9478b4f
--- /dev/null
+++ b/include/tgbot/doxygenMain.h
@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2015 Oleg Morozenkov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef TGBOT_DOXYGENMAIN_H
+#define TGBOT_DOXYGENMAIN_H
+
+/**
+ * @defgroup general
+ * @defgroup types
+ * @defgroup net
+ * @defgroup tools
+ *
+ * @mainpage
+ *
+ * @section Compilation
+ *
+ * Firstly you need to install some dependencies. You have to have boost library at the runtime and cmake at the compilation step to be able to use this library.
+ * On Debian-based distibutives you can do it with these commands:
+ * @code{.sh}
+sudo apt-get install cmake libboost-dev
+ * @endcode
+ *
+ * To compile the library execute this commands:
+ * @code{.sh}
+cd /path/where/you/have/cloned/the/library/repository
+cmake .
+make -j4
+ * @endcode
+ *
+ * That's all. All you have to do now is just link compiled library to your project.
+ *
+ * @section Samples
+ * Simple echo bot which sends everything it recieves:
+ * @code{.cpp}
+int main() {
+    TgBot::Bot bot("PLACE YOUR TOKEN HERE");
+    bot.getEvents().onCommand("start", [&bot](Message::Ptr message) {
+        bot.getApi().sendMessage(message->chat->id, "Hi!");
+    });
+    bot.getEvents().onAnyMessage([&bot](Message::Ptr message) {
+        printf("User wrote %s\n", message->text.c_str());
+        if (StringTools::startsWith(message->text, "/start")) {
+            return;
+        }
+        bot.getApi().sendMessage(message->chat->id, "Your message is: " + message->text);
+    });
+
+    try {
+        printf("Bot username: %s\n", bot.getApi().getMe()->username.c_str());
+
+        TgBot::TgLongPoll longPoll(bot);
+        while (true) {
+            printf("Long poll started\n");
+            longPoll.start();
+        }
+    } catch (TgBot::TgException& e) {
+        printf("error: %s\n", e.what());
+    }
+
+    return 0;
+}
+ * @endcode
+ *
+ * All samples are located [here](https://github.com/reo7sp/tgbot-cpp/tree/master/samples)
+ *
+ * @section Feedback
+ * Feel free to [https://github.com/reo7sp/tgbot-cpp/issues](create new issues on GitHub) or [https://telegram.me/Reo_SP](contact me on Telegram)
+ */
+
+#endif //TGBOT_DOXYGENMAIN_H