From 0b757cbfbf1a4d57c543e8a16a402b481068bad8 Mon Sep 17 00:00:00 2001 From: Mikkeli Matlock Date: Wed, 26 Aug 2026 15:54:52 +0900 Subject: [PATCH] docs: revise batch input requirement for YAML --- REQUIREMENTS.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md index 999ee50..c6d575b 100644 --- a/REQUIREMENTS.md +++ b/REQUIREMENTS.md @@ -9,13 +9,14 @@ - **raw text mode**: `-t ` or `-t ""` (for those including space/tabs); `-t` can be omitted as this is the default mode. - **output path**: `-o PATH/TO/SVG`. Automatically append `.svg` suffix if absent. When whole option is absent, use input text but path-incompatible characters substituted with `_`, and filename capped at 32 chars. - **batch mode**: `-i ` ; output automatically dumps generated svgs per line of input file under `output/`; SVG files named after input lines verbatim except that path-incompatible characters substituted with `_` (underbar), and filename capped at 32 chars. Disregard `-o`. -- **batch mode with `toml`**: `--toml .toml`; the input TOML should be of a flat structure: - ```toml +- **batch mode with `yaml`**: `--yaml .yaml`; the input YAML should be of a flat structure: + ```yaml item0: text0 item1: text1 item2: text2 and there can be spaces ``` output files go under `output/` and are named `item0.svg`, `item1.svg`, etc. + Reject invalid YAML without generating output files. ## svg generation -- Generate convex paths, not weighted edges \ No newline at end of file +- Generate convex paths, not weighted edges