-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
issue-100, getting started information was added #115
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a quick 101 into the project, looks good.
Some minor fixes needed and we can go from here.
README.md
Outdated
To compress a file using the BRRO Compressor, run: | ||
|
||
```bash | ||
brro-compressor --compressor fft <input-file> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need to provide a compressor for compressing. It picks auto
by default
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
README.md
Outdated
-h, --help Print help | ||
-V, --version Print version | ||
``` | ||
--compressor <COMPRESSOR> [default: auto] [possible values: auto, noop, fft, wavelet, constant, polynomial, top-bottom] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noop
, wavelet
, top-bottom
are gone, we can remove those.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
95b4465
to
2a12093
Compare
2a12093
to
8e1f9aa
Compare
Relates to #100