From 52968207531d78836a2f9dbe2b16436a443ba68c Mon Sep 17 00:00:00 2001 From: "Kay Marquardt (Gnadelwartz)" Date: Fri, 24 May 2019 14:55:05 +0200 Subject: [PATCH] fix bashbot in a nutshell --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 57d1f5c..79d374b 100644 --- a/README.md +++ b/README.md @@ -59,26 +59,26 @@ Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Do * [Examples](examples/README.md) ### Your really first bashbot in a nutshell -To install an run bashbot you need acess to a linux/unix/bsd etc. command line. All linux/unix/bsd systems has the comamnds to run bashbot installed if bash is availible. If you don't know how to get accces to a linux/unix/bsd like command line you should stop reading here :-( +To install an run bashbot you need acess to a linux/unix/bsd command line. If you don't know how to get accces to a linux/unix/bsd like command line you should stop reading here :-( -In addition you need a [Telegram client](https://telegram.org) and an a mobile phone to [register an account](https://telegramguide.com/create-a-telegram-account/). -If you don't want to install and register for Telegram you should stop reading here ;-) +In addition you need a [Telegram client](https://telegram.org) and a mobile phone to [register an account](https://telegramguide.com/create-a-telegram-account/). +If you don't want to register for Telegram you should stop reading here ;-) -After you are registered to telegram open a chat with [@botfather](https://telegram.me/botfather) to -[create a new Telegram Bot token](doc/1_firstbot.md). Write down the bot token you get from botfather, you need it while installing the bot. +After you are registered to Telegram send a message to [@botfather](https://telegram.me/botfather) to +[create a new Telegram Bot token](doc/1_firstbot.md) and write it down. You need it later to install the bot. -Now open the linux/unix/bsd command line and check if bash is installed by running ```which bash && echo "bash installed!"```. -If you get an error message conatct you system administrator to install bash. +Now open a linux/unix/bsd terminal and check if bash is installed: ```which bash && echo "bash installed!"```. +If you get an error message bash is not installed. -Create a new, empty drirectory and change to it, e.g. ```mkdir tbb; cd tbb```, and download the '*.tar.gz' file from the lastest bashbot release from -```https://github.com/topkecleon/telegram-bot-bash/releases``` an copy it to the new directory. This can be done with the following command: +Create a new directory and change to it: ```mkdir tbb; cd tbb``` and download the latest '*.tar.gz' file from +```https://github.com/topkecleon/telegram-bot-bash/releases```. This can be done with the commands: ```bash wget -q https://github.com/$(wget -q https://github.com/topkecleon/telegram-bot-bash/releases/latest -O - | egrep '/.*/.*/.*tar.gz' -o) ``` -To install bashbot extract thew archive an change to bashbot directory by running ```tar -xzf *.tar.gz; cd telegram-bot-bash```, -install bashbot with the command ```./bashbot.sh init``` and enter your bot token when asked. All other questions can be answered -by hitting the key. +Extract the '*.tar.gz' file and change to bashbot directory: ```tar -xzf *.tar.gz; cd telegram-bot-bash```, +install bashbot: ```./bashbot.sh init``` and enter your bot token when asked. All other questions can be answered +by hitting the \ key. Thats all, now you can start your bot with ```./bashbot.sh start``` and send him messages: ``` @@ -95,7 +95,7 @@ You are Botadmin his is bashbot, the Telegram bot written entirely in bash. It features background tasks and interactive chats, and can serve as an interface for CLI programs. ``` -For more Information on how to install, customize and use your new bot, read the [Documentation](Documentation) +For more Information on how to install, customize and use your new bot, read the [Documentation](#Documentation) ---- @@ -149,4 +149,4 @@ Hey no Problem, if you are finished with your cool bot run ```dev/make-standalon If you feel that there's something missing or if you found a bug, feel free to submit a pull request! -#### $$VERSION$$ v0.80-0-g5bce3f7 +#### $$VERSION$$ v0.80-6-g5fa7b2e