drewcassidy/yaclog-ksp
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog-ksp.git synced 2024-09-01 14:58:44 +00:00
Code Issues Projects Releases Wiki Activity

Fix readme

Browse Source
This commit is contained in:
Andrew Cassidy 2021-05-07 15:54:20 -07:00
parent d170e0b1e7
commit 8462861479
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -20,9 +20,7 @@ Usage: yaclog-ksp [OPTIONS]
Converts markdown changelogs to KSP changelog configs.
Options:
-i, --input FILE Input markdown file to read from. [default:
CHANGELOG.md]
--path FILE Location of the changelog file. [default: CHANGELOG.md]
-o, --output FILE Output file to write to. Uses
'GameData/{name}/Versioning/{name}ChangeLog.cfg' by
default.
@ -32,10 +30,9 @@ Options:
--version Show the version 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`
Input files are in markdown, and use a certain syntax to be readable by the tool. Metadata is included in a table at the