search

lamdav / AudioConverter

Audio Conversion CLI
https://pypi.org/project/AudioConverter/
MIT License
36 stars 11 forks source link

Updated README with example output format syntax #3

Closed Wheest closed 4 years ago

Wheest commented 4 years ago

A minor change, however as a new user of the software I was unsure what the syntax for specifying the output format was.

Did I need the ., or should it be all caps, or was there some other way of invoking it?

I spent a minute or so trying to figure it out.

This small example will mean that it will be immediately clear what the syntax is.

lamdav commented 4 years ago

Thanks for the PR. Hopefully this will save future users some time and avoid some confusion.

For future reference, you can run the following to see the help command:

audioconvert convert --help

This will output the following:

Usage: audioconvert convert [OPTIONS] INPUT_DIRECTORY OUTPUT_DIRECTORY

  Convert Input Directory Audio to Output Directory Audio

Options:
  -o, --output-format [.aiff|.flac|.m4a|.mp3|.mp4|.wav]
                                  Target output format
  -w, --workers INTEGER           Number of worker processes to run
  --help                          Show this message and exit.

Overall, the changes LGTM.