aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornytpu <alex@nytpu.com>2021-02-17 10:48:14 -0700
committernytpu <alex@nytpu.com>2021-02-17 10:48:14 -0700
commitf6487ea30f59b8b34a3e7557e22f945ea7bce54a (patch)
tree55bfa3c90ca60dda8bfd338431c0c9fbddf1992a
parentfix error check (diff)
downloadcheetah-bot-f6487ea30f59b8b34a3e7557e22f945ea7bce54a.tar.bz2
cheetah-bot-f6487ea30f59b8b34a3e7557e22f945ea7bce54a.zip
make usage description in readme more detailed
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index bf4cdd0..e21721b 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
# cheetah-bot
-A bot to automatically post pictures to reddit and mastodon. ostensibly
+A bot to automatically post pictures to Reddit and Mastodon. Ostensibly posts
cheetah pictures, but it'll work on anything.
+Entirely conceived, researched, and written in around an hour, so the code is
+not necessarily what could be called “high quality.”
+
## usage
@@ -27,8 +30,13 @@ App Secret: <client secret>
User Token: <access token>
```
-edit various paths in cheetah-bot.go, then compile. just set it to fire on a
-cron job, it's a one-shot affair.
+Put those in `/var/local/cheetahs/`. Also name your image files in the format
+of `DXXX.jpg` (you need 3 digits) and add a description of them in the format
+`DXXX.desc`, and put all of them in `/var/local/cheetahs/`. If you want to
+start at a day other than 1, make a `/var/local/cheetahs/day.txt` only
+containing the day you want to start at.
+
+Then just set it to fire on a cron job, it's a one-shot affair.
## building