Merge branch 'master' of code.communitydata.science:coldcallbot-discord

[coldcallbot-discord.git] / README

diff --git a/README b/README
index a972038157f8d3f73df874a8779bbfb5d20eefcf..733a2e8c1ad42012471a70bf8e5bb9735ffb69d2 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,27 @@
 Setting up the Discord Bot
 ======================================
 
-I run the Discord boy from my laptop. It requires the discord Python
+I run the Discord bot from my laptop. It requires the discord Python
 module available in PyPi and installable like:
 
     $ pip3 install discord
 
-I don't have details on how I set up my own Discord bot and/or invited
-it to my server but I hope you'll add to this file as you do this and
-figure out what needs to happen.
+Setting up the Bot
+=====================================
+
+The documentation for the `discord` python package
+(https://discordpy.readthedocs.io/en/latest/discord.html) does a good
+job explaining how to set up a Discord bot with your server. Follow
+the steps there, with one important exception:
+
+1. On the "Bot" tab in the discord application configuration page you
+need to enable both "Privileged Gateway Intents."  This allows the bot
+to see who is present and active in the channel.
+
+Finally, you need to copy your bot'ss Token (also found on the "Bot" tab)
+into coldcallbot.py. Pass it as the argument to `ccb.run()`.
+
+
 
 Using the Cold Call Bot
 ======================================
@@ -31,7 +44,7 @@ Daily Process
 
 You need to start the bot from the laptop each day. I do that by:
 
-  $ ./coldcallboy.py
+  $ ./coldcallbot.py
 
 The bot will run in the terminal, print out data as it works including
 detailed weights as it goes, and it will record data into files in the
@@ -129,6 +142,12 @@ compute_final_case_grades.R:
     `myuw-COM_482_A_autumn_2020_students.csv`) which is described
     above.
 
+    To run this script, you will need to create the following subdirectories:
+
+    data/case_grades
+    data/case_grades/student_reports
+
+
 One final note: A bunch of things in these scripts assumes a UW 4.0
 grade scale. I don't think it should be hard to map these onto some
 other scale, but that's an exercise I'll leave up to those that want