aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorromangraef <roman.graef@gmail.com>2018-07-04 14:08:56 +0200
committerromangraef <roman.graef@gmail.com>2018-07-04 14:08:56 +0200
commit168a8ed88b48b539f09bc77bfad3122e7a986675 (patch)
treeb4e3d2e4cb725fd9aa35ad999fbba7682de12d26 /README.md
downloadevalbot-168a8ed88b48b539f09bc77bfad3122e7a986675.tar.gz
evalbot-168a8ed88b48b539f09bc77bfad3122e7a986675.tar.bz2
evalbot-168a8ed88b48b539f09bc77bfad3122e7a986675.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a2034d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+EVALBOT
+------
+
+Discord Code eval bot using the [Compilebot][compilebot] API.
+
+### SETUP
+ - Create a discord bot account at [the discord developers page][discord-devs]. **IMPORTANT** Create a bot user as well.
+ - Go to the [Compilebot][compilebot] website and subscribe to a plan.
+ - clone the repository and create a [Virtual Environment][venv]
+ - Install all the requirements via `pip install -r requirements.txt`
+ - Create a `config.ini` in the following format:
+```ini
+[discord]
+token = YOURDISCORDTOKEN. DISCORD! TOKEN! NOT ID OR SECRET
+
+[jdoodle]
+id = yourcompilebotid
+secret = yourcompilebotsecret
+```
+ - Launch the bot via `python main.py`. If you want to run the bot permanently i recommend using `tmux` or `screen`.
+
+[compilebot]: https://www.jdoodle.com/compiler-api/
+[discord-devs]: https://discordapp.com/developers/applications/me
+[venv]: https://docs.python.org/3/library/venv.html