Fix readme

dev
Andrew Cassidy 3 years ago
parent d170e0b1e7
commit 8462861479

@ -20,9 +20,7 @@ Usage: yaclog-ksp [OPTIONS]
Converts markdown changelogs to KSP changelog configs. Converts markdown changelogs to KSP changelog configs.
Options: Options:
-i, --input FILE Input markdown file to read from. [default: --path FILE Location of the changelog file. [default: CHANGELOG.md]
CHANGELOG.md]
-o, --output FILE Output file to write to. Uses -o, --output FILE Output file to write to. Uses
'GameData/{name}/Versioning/{name}ChangeLog.cfg' by 'GameData/{name}/Versioning/{name}ChangeLog.cfg' by
default. default.
@ -32,10 +30,9 @@ Options:
--version Show the version and exit. --version Show the version and exit.
--help Show this message and exit. --help Show this message and exit.
``` ```
for example, running `yaclog-ksp -i MyLog.md -n "My KSP Mod"` for example, running `yaclog-ksp --path MyLog.md -n "My KSP Mod"`
would output to `GameData/MyKSPMod/Versioning/MyKSPModChangeLog.cfg` would output to `GameData/MyKSPMod/Versioning/MyKSPModChangeLog.cfg`
Input files are in markdown, and use a certain syntax to be readable by the tool. Metadata is included in a table at the Input files are in markdown, and use a certain syntax to be readable by the tool. Metadata is included in a table at the

Loading…
Cancel
Save