Skip to content
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

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Conversation

DoodgeMatvey
Copy link
Contributor

Relates to #100

@DoodgeMatvey DoodgeMatvey added documentation Improvements or additions to documentation opensource-release Issues related to the opensource release of the repo labels Sep 2, 2024
@DoodgeMatvey DoodgeMatvey self-assigned this Sep 2, 2024
Copy link
Collaborator

@cjrolo cjrolo left a 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>
Copy link
Collaborator

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

Copy link
Contributor Author

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]
Copy link
Collaborator

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

@cjrolo cjrolo merged commit 4d14a5d into main Sep 26, 2024
2 checks passed
@cjrolo cjrolo deleted the add-getting-started branch September 26, 2024 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation opensource-release Issues related to the opensource release of the repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants