summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOleg Morozenkov <omorozenkov@gmail.com>2018-11-24 09:40:30 +0300
committerGitHub <noreply@github.com>2018-11-24 09:40:30 +0300
commit158c179beb3d06f110d665075d5e283e24592de6 (patch)
tree465d04c0ebbf573ddb0fa57ce2015bd44efd4ddf /README.md
parentb35438dd77e4c2391391d7777c0a0b4cfd6e46f5 (diff)
parentba46cf2f3c9f253b84139f3b7229fe39fe5714ef (diff)
Merge pull request #85 from ingjieye/master
Update CMakeLists.txt so tgbot-cpp can be used as a submodule
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index fc7e330..c2345a8 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ int main() {
All other samples are located [here](samples).
-## Library compilation
+## Dependencies
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:
```sh
@@ -66,14 +66,20 @@ sudo apt-get install g++ make binutils cmake libssl-dev libboost-system-dev
```
If you want to use curl-based http client `CurlHttpClient`, you also need to install `libcurl4-openssl-dev` package.
-To compile the library execute this commands:
+## Library installation
+
+If you want to install the library system-wide:
+
```sh
-cd /path/where/you/have/cloned/the/library/repository
+git clone https://github.com/reo7sp/tgbot-cpp
+cd tgbot-cpp
cmake .
make -j4
sudo make install
```
+Or you can treat this repository as a submodule of your project, for example, see [echobot-submodule](samples/echobot/CMakeLists.txt)
+
## Specific library installation notes
### Docker