search

mohanson / gameboy

Full featured Cross-platform GameBoy emulator by Rust. Forever boys!.
MIT License
1.36k stars 79 forks source link

make command line options more discoverable #19

Closed ethanpailes closed 4 years ago

ethanpailes commented 4 years ago

First, this is an awesome project! I looked into a couple of other gameboy emulators with many more commits and contributors before trying out this one, and this was the first project that worked.

I'm fortunate enough to be able to figure out the command line flags by reading sources, but I suspect that not everyone who is interested in using this project will have that option open to them so I thought I would send you a patch to try to make the command line flags a little more discoverable.

Adding the long-form flags gives argparse something to use as the argument name in its help message. The new usage message is:

Usage:
  target/debug/gameboy [OPTIONS] [ROM]

Gameboy emulator

Positional arguments:
  rom                   Rom name

Optional arguments:
  -h,--help             Show this help message and exit
  -a,--enable-audio     Enable audio
  -x,--scale-factor SCALE_FACTOR
                        Scale the video by a factor of 1, 2, 4, or 8

I also fixed a compiler warning.

mohanson commented 4 years ago

Thanks for your work!