From b2b8b19c1b305b435ae5ab64e075df6d3c6e7511 Mon Sep 17 00:00:00 2001 From: xenofem Date: Sun, 9 Jul 2023 09:36:46 -0400 Subject: [PATCH] update README with info about the `parts` key in `shows.yaml` --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0124db3..4f07ca6 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,11 @@ Gundam 0079: - MSG 0079 - "0079" - First Gundam +MS IGLOO: + path: /home/user/media/Gundam Igloo + parts: + 1: The Hidden One Year War + 2: Apocalypse 0079 ``` each top-level key is a show title, which will be used in spoiler @@ -54,3 +59,7 @@ warnings on posts and in image alt text. each show has two keys: the episodes must be directly inside the directory, the bot will not traverse subdirectories to find files. - `tags`: an optional list of tags to put on posts from this show. +- `parts`: an optional map of season numbers to season names. + by default, if the bot detects episodes from multiple seasons in a directory, + it will refer to them as "season [number]" in post CWs and image alt-text. + this is a map rather than a list, since show season numbers may be 1-indexed or 0-indexed. \ No newline at end of file