slp-to-mp4 icon indicating copy to clipboard operation
slp-to-mp4 copied to clipboard

Documentation Stuff

Open ghbrown opened this issue 4 years ago • 1 comments

First, just wanted to say great job and thank you. I was hoping something exactly like this existed, and so far it is working beautifully and doing just what I had wanted it to.

I also would like to suggest a few clarifications on the README.md and documentation. The first thing (regardless of platform) is to put the full shell input line for the example runs: $ python[3] slp-to-mp4.py REPLAY_FILE [OUTPUT_FILE_OR_DIRECTORY] This is clear in hindsight, but the line above would have saved me a few minutes and some confusion. Also, I would clarify that [stuff] means that the stuff input is optional. This is reasonably common notation, and doesn't matter much in the long run since the output will just be bracketed, but it could be nice for completeness and clarity.

More importantly, perhaps, is the matter of slashes in the Dolphin, ffmepg, and iso paths. On Windows 10 I got a json decode error due to premature escapes. This was solved easily enough by adding a \ to every existing \, but this is the sort of thing which might be preferable to fix inside the Python program instead. If it's not possible to fix in the script, then perhaps just add a note under the Windows documentation about it.

Thanks again.

ghbrown avatar Nov 14 '20 00:11 ghbrown

Thanks @GHBrown, you raise good points. I don't have time to fix it right now. I'll leave this issue open - maybe someone will submit a PR with these changes.

NunoDasNeves avatar Jan 30 '21 05:01 NunoDasNeves