Added README
This commit is contained in:
parent
7c89395f70
commit
8f74565abd
1 changed files with 28 additions and 0 deletions
28
README.md
Normal file
28
README.md
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
# Hrochobot
|
||||||
|
Discord bot for KSP discord server.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First install all required libraries:
|
||||||
|
```sh
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Then create ``data`` folder from ``data.example``:
|
||||||
|
```sh
|
||||||
|
cp data.example data -r
|
||||||
|
```
|
||||||
|
Same for ``config.json``:
|
||||||
|
```sh
|
||||||
|
cp config.example.json config.json -r
|
||||||
|
```
|
||||||
|
|
||||||
|
Lastly paste your discord bot token into ``config.json``.
|
||||||
|
If you do not have any discord bot, learn how to create one here:
|
||||||
|
https://discordjs.guide/preparations/setting-up-a-bot-application.html#your-bot-s-token
|
||||||
|
|
||||||
|
|
||||||
|
## Running
|
||||||
|
To run the bot simply execute ``main.py``:
|
||||||
|
```sh
|
||||||
|
./main.py
|
||||||
|
```
|
Loading…
Reference in a new issue