chore: updated reqs

This commit is contained in:
Mikkeli Matlock
2026-08-26 15:39:36 +09:00
parent ec4f20a5ed
commit 580c796491
+8
View File
@@ -1,6 +1,14 @@
# Reqs
## python package managment
- Use `uv`
- Ignore `uv.lock` even if it's against the spirit; causes trouble when going cross-architecture
- app should be runnable with only `uv run svgqr <ARGS>` or `svgqr <ARGS>`
## cli options (args)
- **raw text mode**: `-t <TEXT>` or `-t "<TEXT>"` (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 <FILE_OF_LINES_TO_CONVERT>` ; 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`.
## svg generation
- Generate convex paths, not weighted edges