Added info for running the bot.

This commit is contained in:
Vegard Berg 2022-07-22 23:55:36 +02:00
parent 8f1e003d7b
commit a9920e44d1
1 changed files with 5 additions and 0 deletions

View File

@ -2,6 +2,11 @@
This is a complete rewrite of the [Heimdallr bot](https://gitlab.com/NorwegianLanguageLearning/heimdallr) in Python. This is a complete rewrite of the [Heimdallr bot](https://gitlab.com/NorwegianLanguageLearning/heimdallr) in Python.
The rewritten version of Heimdallr supports multiple servers, and it should be easier to add new features. The rewritten version of Heimdallr supports multiple servers, and it should be easier to add new features.
# Running
Install Heimdallr's dependencies with Poetry (`poetry install`)
From the current directory, run `poetry run Heimdallr.py`.
**NB:** The environment variable `DISCORD_TOKEN` must be set to a working bot token.
# Commands # Commands
`Monospaced` text indicates command usage. `<argument>` indicates a required argument. `[argument]` indicates an optional argument. `Monospaced` text indicates command usage. `<argument>` indicates a required argument. `[argument]` indicates an optional argument.
## Quote ## Quote