From c584d8614a3b1ad10c049577e4209943f64e03e2 Mon Sep 17 00:00:00 2001 From: Jeremy Zhang Date: Sat, 6 May 2017 18:46:39 -0700 Subject: [PATCH] Update discordbot readme --- discordbot/README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/discordbot/README.md b/discordbot/README.md index 0472b08..4880b6a 100644 --- a/discordbot/README.md +++ b/discordbot/README.md @@ -1,6 +1,9 @@ # Titan - DiscordBot Portion The DiscordBot portion handles the communcation with Discord's websockets to provide real-time updates. The bot's primary role is to push content to the webapp's database to be retrieved at a later time. -It also includes misc. features to moderate guest users, etc. +It also includes misc. features to moderate guest users, etc. right in your discord server! # Installation -1. TODO, Sorry about that! (Though if you want to get ahead, install the latest discord.py pip package and that will require **Python 3.5**) \ No newline at end of file +1. Clone the repo (make sure you have **Python 3.5** installed on your system. This discordbot portion depends on that specifc Python version) +2. Install the pip requirements `pip install -r requirements.txt` +3. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards +4. Start the bot using `python run.py`