summaryrefslogtreecommitdiff
path: root/include/tgbot/tgbot.h
diff options
context:
space:
mode:
authorOleg Morozenkov <omorozenkov@gmail.com>2015-08-11 22:52:05 +0300
committerOleg Morozenkov <omorozenkov@gmail.com>2015-08-11 22:52:05 +0300
commit7b3fa406eb228a00ef9f053bd2177d53b61b1d3d (patch)
tree8de1665685afcd20bb51ef8e88475d9c5776731a /include/tgbot/tgbot.h
parent3447b4578c673f625a3fcd006ddf73cbe3505e48 (diff)
Global header file
Diffstat (limited to 'include/tgbot/tgbot.h')
-rw-r--r--include/tgbot/tgbot.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/include/tgbot/tgbot.h b/include/tgbot/tgbot.h
new file mode 100644
index 0000000..21224c8
--- /dev/null
+++ b/include/tgbot/tgbot.h
@@ -0,0 +1,97 @@
+/*
+ * 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_TGBOT_H
+#define TGBOT_TGBOT_H
+
+#include "tgbot/Bot.h"
+#include "tgbot/Api.h"
+#include "tgbot/TgException.h"
+#include "tgbot/TgTypeParser.h"
+#include "tgbot/EventBroadcaster.h"
+#include "tgbot/EventHandler.h"
+#include "tgbot/types/Audio.h"
+#include "tgbot/types/Contact.h"
+#include "tgbot/types/Document.h"
+#include "tgbot/types/ForceReply.h"
+#include "tgbot/types/GenericChat.h"
+#include "tgbot/types/GenericReply.h"
+#include "tgbot/types/GroupChat.h"
+#include "tgbot/types/InputFile.h"
+#include "tgbot/types/Location.h"
+#include "tgbot/types/Message.h"
+#include "tgbot/types/PhotoSize.h"
+#include "tgbot/types/ReplyKeyboardHide.h"
+#include "tgbot/types/ReplyKeyboardMarkup.h"
+#include "tgbot/types/Sticker.h"
+#include "tgbot/types/Update.h"
+#include "tgbot/types/User.h"
+#include "tgbot/types/UserProfilePhotos.h"
+#include "tgbot/types/Video.h"
+#include "tgbot/tools/StringTools.h"
+#include "tgbot/net/HttpClient.h"
+#include "tgbot/net/HttpParser.h"
+#include "tgbot/net/HttpReqArg.h"
+#include "tgbot/net/HttpServer.h"
+#include "tgbot/net/TgLongPoll.h"
+#include "tgbot/net/TgWebhookLocalServer.h"
+#include "tgbot/net/TgWebhookServer.h"
+#include "tgbot/net/TgWebhookTcpServer.h"
+#include "tgbot/net/Url.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 g++ make binutils cmake libssl-dev libboost-system-dev libboost-iostreams-dev libboost-test-dev
+ * @endcode
+ *
+ * To compile the library execute this commands:
+ * @code{.sh}
+ * cd /path/where/you/have/cloned/the/library/repository
+ * cmake .
+ * make -j4
+ * sudo make install
+ * @endcode
+ *
+ * That's all. All you have to do now is just link compiled library to your project.
+ *
+ * @section Samples
+ * All samples are located [here](https://github.com/reo7sp/tgbot-cpp/tree/master/samples)
+ *
+ * @section Feedback
+ * Feel free to [create new issues on GitHub](https://github.com/reo7sp/tgbot-cpp/issues) or [contact me on Telegram](https://telegram.me/Reo_SP)
+ *
+ * @section Licence
+ * [The MIT License](http://opensource.org/licenses/MIT)
+ */
+
+#endif //TGBOT_TGBOT_H