Drop unused arguments from README #103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tmatth
reviewed
Jan 18, 2021
README
Outdated
| @@ -12,6 +12,6 @@ While it is meant to be used as a library, a simple command-line tool is | |||
| provided as an example. It operates on RAW 16-bit (machine endian) mono | |||
| PCM files sampled at 48 kHz. It can be used as: | |||
|
|
|||
| ./examples/rnnoise_demo <number of channels> <maximum attenuation> < input.raw > output.raw | |||
| ./examples/rnnoise_demo <input.raw> output.raw | |||
There was a problem hiding this comment.
You could also just use the same form as the usage message which I think is a bit clearer:
<noisy speech> <output denoised>
See:
rnnoise/examples/rnnoise_demo.c
Line 41 in 125d8a5
There was a problem hiding this comment.
Changed to using the same form as the usage message :)
tmatth
approved these changes
Jan 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When trying to run the example, the script spits out
usage: rnnoise_demo <noisy speech> <output denoised>I think this should be in the readme as the
rnnoise_demodoes not seem to accept neithernumber of channelsnormaximum attenuationarguments.