aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-05 11:41:06 +0200
committerDanilo M. <danix@danix.xyz>2026-10-05 11:41:06 +0200
commite3e08870d4d120145d5667a16602fc3a15167b76 (patch)
treed9b8225775413f76282e108f7515309c3fae3f93 /README.md
parent7017ceddad7750c54aed5a4323aec0ef3f2e119f (diff)
downloadfanfictioner-e3e08870d4d120145d5667a16602fc3a15167b76.tar.gz
fanfictioner-e3e08870d4d120145d5667a16602fc3a15167b76.zip
Take series, book, chapter and title from story.md frontmatter
An optional --- frontmatter in the story file sets the names instead of letting Gemma invent them. The script writes them into plan.md after every draft and revision and whenever story.md changes. With a chapter number, pages are saved as CC-NNN.png so all chapters of a book share one folder and read in order in book-reader. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index dd83a60..4ce0704 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,23 @@ image stage. Pages land in the book-reader library as `NNN.png`.
## Usage
+A story file is free prose. An optional frontmatter at the top sets the names
+instead of letting Gemma invent them; every key is optional:
+
+ ---
+ series: A new life
+ book: Life as Daniel
+ chapter: 1
+ chapter_title: Intro
+ title: Meet Daniel
+ ---
+
+`series` and `book` name the library folders, `title` is the cover lettering,
+`chapter_title` heads plan.md. With `chapter`, pages are saved as
+`01-001.png`, `01-002.png`, so every chapter of a book (one story file each)
+reads as one continuous book in book-reader. These values always override what
+Gemma writes in plan.md.
+
fanfictioner story.md [--base zimage|krea2]
fanfictioner --selftest