From c21398785972df83a64ae2b5eef5592ee8cfc649 Mon Sep 17 00:00:00 2001
From: Luna <git@l4.pm>
Date: Sat, 10 Jun 2023 18:36:18 -0300
Subject: [PATCH] add usage notes to readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fe130f0..f15069c 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,33 @@ score formula:
 
 then average for all posts
 
+system dependencies:
+ - python3
+ - [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) with the [tagger extension](https://github.com/toriato/stable-diffusion-webui-wd14-tagger)
+ - [hydrus-dd](https://gitgud.io/koto/hydrus-dd)
+
 ```sh
 python3 -m venv env
 env/bin/pip install -Ur ./requirements.txt
-env/bin/python3 ./main.py
+
+# by default, downloads 30 images at page 150 of the default empty query
+env/bin/python3 ./main.py download_images
+
+# gets 40 images at page 150 from tag 'rating:questionable'
+# you should add more tags to diversify the dataset before calculating scores
+env/bin/python3 ./main.py download_images 'rating:questionable' 40 150
+
+# configure interrogators / tagger models
+# set sd_webui_address to your stable diffusion webui' address
+# set dd_address to hydrus-dd's address
+# and set dd_model_name to be something identifiable about the model
+# i set it to the md5sum output of my file, to make sure that if the file
+# changes back on koto's end, my numbers may be different
+cp config.example.json config.json
+
+# fight mode -- run all interrogators against the dataset you've downloaded
+env/bin/python3 ./main.py fight
+
+# score mode -- crank the final numbers, generates graphs under plots/ folder
+env/bin/python3 ./main.py fight
 ```
\ No newline at end of file