From 14bf658b86d18e941a1338f1364f2b527ea4f52b Mon Sep 17 00:00:00 2001 From: Luckydonald <2737108+luckydonald@users.noreply.github.com> Date: Thu, 10 Dec 2020 22:23:16 +0100 Subject: [PATCH] Documented what to do if you forgot the --recursive flag, (#21) added code highlighting to the code blocks. --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2eaef15..6c561ba 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ The bot will now receive Updates for all received media, even if a destruction t ## Installation The simplest way to use it is with this docker command: -``` +```bash docker run -p 8081:8081 --env TELEGRAM_API_ID=API_ID --env TELEGRAM_API_HASH=API_HASH tdlight/tdlightbotapi ``` @@ -139,8 +139,8 @@ If you do that, you'll only need to choose the target operating system to receiv In general, you need to install all `Telegram Bot API server` [dependencies](#dependencies) and compile the source code using CMake: -``` -git clone --recursive https://github.com/tdlib/telegram-bot-api.git +```bash +git clone --recursive https://github.com/tdlight-team/tdlight-telegram-bot-api cd telegram-bot-api mkdir build cd build @@ -148,6 +148,12 @@ cmake -DCMAKE_BUILD_TYPE=Release .. cmake --build . --target install ``` +If you forgot that `--recursive` flag at the clone part, you can just navigate into that created folder and run +```bash +cd tdlight-telegram-bot-api +git submodule update --init --recursive +``` + ## Dependencies To build and run `Telegram Bot API server` you will need: @@ -157,6 +163,7 @@ To build and run `Telegram Bot API server` you will need: * C++14 compatible compiler (e.g., Clang 3.4+, GCC 4.9+, MSVC 19.0+ (Visual Studio 2015+), Intel C++ Compiler 17+) (build only) * gperf (build only) * CMake (3.0.2+, build only) +* _having it cloned with `--recursive` (see [above](#installation)) to get `tdlib`_ ## Usage