mikkeli/svg-qr-gen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: modified README and added Reqs

Browse Source
This commit is contained in:
Mikkeli Matlock
2026-08-26 15:37:52 +09:00
parent 717641e769
commit ec4f20a5ed
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
-2
View File
@@ -7,5 +7,3 @@ Generates SVG QR codes from any text input.
```
python qr.py <TEXT> -o <OUTPUT_PATH>
```
## notice
REQUIREMENTS.md
+6
View File
@@ -0,0 +1,6 @@
# Reqs
## 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`.