Initial readme, minor formatting changes.

This commit is contained in:
Alexis Werefox 2021-08-29 23:28:25 +00:00
parent 8ab883d0b9
commit d4fd8c9519
3 changed files with 52 additions and 29 deletions

View file

@ -0,0 +1,19 @@
# Werefox Discord Bot
This is a Discord bot I've made in Python to use for the Discord server I'm putting together for my streams.
## Setup
Right now I've only tested the bot in a Docker container. The following command will build the container from the `Dockerfile` incuded and then run it.
`sudo docker-compose up --build --force-recreate --remove-orphans -d`
If you wish to simply run the container without re-building it, you can remove the `--build` and `--force-recreate` tags.
`sudo docker-compose up --remove-orphans -d`
Additionally, in most cases, `--remove-orphans` is not strictly necessary.
## Usage
_TODO: This section should probably point to a wiki of commands and such..._

View file

@ -1,5 +1,9 @@
#!/bin/python #!/bin/python
from lib.werefox_bot_runtime import run from asyncio import sleep, run
try:
from volumes.python.lib.werefox_bot_runtime import run as werefox_run
except:
from lib.werefox_bot_runtime import run as werefox_run
run() werefox_run()