diff options
Diffstat (limited to 'docs/index.html')
| -rw-r--r-- | docs/index.html | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..3c5f48b --- /dev/null +++ b/docs/index.html @@ -0,0 +1,132 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.11"/> +<title>tgbot-cpp: Main Page</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.11 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li class="current"><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('index.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">tgbot-cpp Documentation</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p><a href="https://github.com/reo7sp/tgbot-cpp">Go to GitHub</a></p> +<h1><a class="anchor" id="lib_compile"></a> +Library compilation</h1> +<p>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: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> sudo apt-get install g++ make binutils cmake libssl-dev libboost-system-dev</div></div><!-- fragment --><p>To compile the library execute this commands: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> cd /path/where/you/have/cloned/the/library/repository</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> cmake .</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> make -j4</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> sudo make install</div></div><!-- fragment --><h1><a class="anchor" id="bot_compile"></a> +Bot compilation</h1> +<p>With CMake: <a href="samples/echobot/CMakeLists.txt">Example CMakeLists.txt</a></p> +<p>Without CMake: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> g++ telegram_bot.cpp -o telegram_bot --std=c++11 -I/usr/local/include -lTgBot -lboost_system -lssl -lcrypto -lpthread</div></div><!-- fragment --><p>Also: You can use Docker to build and run your bot. Set the base image of your's Dockerfile to <a href="https://hub.docker.com/r/reo7sp/tgbot-cpp/">reo7sp/tgbot-cpp</a>.</p> +<h1><a class="anchor" id="Samples"></a> +Samples</h1> +<p>All samples are located <a href="https://github.com/reo7sp/tgbot-cpp/tree/master/samples">here</a></p> +<h1><a class="anchor" id="Feedback"></a> +Feedback</h1> +<p>Feel free to <a href="https://github.com/reo7sp/tgbot-cpp/issues">create new issues on GitHub</a> or <a href="https://t.me/reo7sp">contact me on Telegram</a></p> +<h1><a class="anchor" id="Licence"></a> +Licence</h1> +<p><a href="http://opensource.org/licenses/MIT">The MIT License</a> </p> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Fri Jun 22 2018 22:14:17 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> + </ul> +</div> +</body> +</html> |