diff --git a/README.md b/README.md index 2c08cfe..ea32c68 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ 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. +# 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 `Monospaced` text indicates command usage. `` indicates a required argument. `[argument]` indicates an optional argument. ## Quote