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

Add snap support steps into readme file #116

Merged
merged 3 commits into from
Oct 30, 2020

Conversation

purveshpatel511
Copy link
Contributor

Hey, I am adding snap installation guide into readme file.

README.md Outdated
@@ -101,6 +101,17 @@ If you have Rust 1.36 or higher, you can install `hexyl` from source via `cargo`
cargo install hexyl
```

### Via snap package

This package available on snapcraft with 5 different architechture `amd64`, `arm64`, `i386`, `ppc64el` and `s390x` with 4 different channel `stable`, `candidate`, `beta` and `edge`.
Copy link
Owner

Choose a reason for hiding this comment

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

Wouldn't this kind of information be available on a separate page where it's always up-to-date? Couldn't we simply link to https://snapcraft.io/hexyl here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, i would add that.

README.md Outdated
sudo snap install hexyl
```

This package is maintained by Github User [Purvesh Patel](https://github.com/purveshpatel511). You can find snap support repo [here](https://github.com/purveshpatel511/hexyl-snap). Feel free to open any snap related issues on [here](https://github.com/purveshpatel511/hexyl-snap/issues).
Copy link
Owner

Choose a reason for hiding this comment

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

All of this is also available on the snapcraft.io page, which is a better place for this kind of information, IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out. I will move this information.

@sharkdp
Copy link
Owner

sharkdp commented Oct 30, 2020

Thank you very much for your contribution!

If you like, you could also add an entry to the "unreleased" section in CHANGELOG.md. The format for entries is:

- Description what has been changed, see #123 (@user)

where #123 links to the bug ticket and/or the PR and user is your username.

@purveshpatel511
Copy link
Contributor Author

Hey, i modify Changelog and Readme file, as you suggested.

README.md Outdated
```
sudo snap install hexyl
```

This package is maintained by Github User [Purvesh Patel](https://github.com/purveshpatel511). You can find snap support repo [here](https://github.com/purveshpatel511/hexyl-snap). Feel free to open any snap related issues on [here](https://github.com/purveshpatel511/hexyl-snap/issues).
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/hexyl)
Copy link
Owner

Choose a reason for hiding this comment

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

I'm sorry, but I would prefer to have a plain text version here... for consistency with the other installation instructions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure man.

@purveshpatel511
Copy link
Contributor Author

add plain text link in readme file.

@sharkdp sharkdp merged commit c4ed6d9 into sharkdp:master Oct 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants