aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2020-08-01 17:35:34 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2020-08-01 17:35:34 +0100
commit81beed4b8dd2e7fc5365cc5c344d20109d10e7db (patch)
tree87c0c1dad3ce79e91d11a8575a8a60182bf293d4 /readme.md
parent4286c4a895548bdaaa190b248b43b1388e630a62 (diff)
downloadSmallYTChannelBot-81beed4b8dd2e7fc5365cc5c344d20109d10e7db.tar.gz
SmallYTChannelBot-81beed4b8dd2e7fc5365cc5c344d20109d10e7db.zip
updated the readme
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md31
1 files changed, 15 insertions, 16 deletions
diff --git a/readme.md b/readme.md
index b0e12b0..70b63f6 100755
--- a/readme.md
+++ b/readme.md
@@ -1,34 +1,33 @@
# /u/SmallYTChannelBot Source Code
-The source code for /u/SmallYTChannelBot. Currently refactoring is in progress.
+The source code for /u/SmallYTChannelBot. This is a WIP branch that uses MySQL
+instead of SQLite3 and is designed to work in a docker container.
-# TODOs
-
-- [x] Automatically flair when [] is in submission title (done with AutoModerator)
+# Docker
-- [ ] Implement `!recheck` command to recheck already removed submissions
+- Clone the repo
-- [ ] Ignore bot commands when they're formatted as code (` ` or indentation)
+- Edit the configuration file and rename
-- [ ] Write a bot for the discord
+- If applicable, download the newest SQLite3 database and run the migration script
-- [ ] Implement a stream for edited comments
+- Build the image:
-- [x] Removed giving lambda in free posts
+`sudo docker build -t smallytchannelbot:latest .`
-- [x] Removed lambda for giving lambda
+- Start the container:
-- [x] Switched to using a JSON file for configuration, included template
+`sudo docker run --name smallytchannelbot --net=host -d smallytchannelbot`
-- [x] Refactored main code
+# TODOs
-- [x] Changed license from MIT to GPLv3
+- [ ] Implement `!recheck` command to recheck already removed submissions
-- [x] Update flair when using the !takelambda command
+- [ ] Ignore bot commands when they're formatted as code (` ` or indentation)
-- [x] Reimplented the `!takelambda` command
+- [ ] Write a bot for the discord
-- [x] Change `!takelambda` to `!refundlambda` when negative
+- [ ] Implement a stream for edited comments
# About the database's structure