drahnr / cargo-spellcheck

Checks all your documentation for spelling and grammar mistakes with hunspell and a nlprule based checker for grammar
Apache License 2.0
314 stars 32 forks source link

Documentation: cargo-binstall and GitHub Actions #298

Closed EdJoPaTo closed 1 year ago

EdJoPaTo commented 1 year ago

What does this PR accomplish?

See #297

Changes proposed by this PR:

Describe usage of cargo-binstall and a GitHub Action which uses cargo-binstall.

I also had some minor changes to the documentation there:

Switch -m to --code as long options especially in documentation and scripts are easier to read and understand (at least for me).

Switch from /usr/bin/sh to /usr/bin/env bash. sh is most often a symlink to the default shell which easily breaks on systems where the default shell isn't POSIX compliant (like fish or nushell) or the writer of the script expects bash features.

Notes to reviewer:

Until a new release with updated release artefact names is released or the current latest is updated with different release artefact names cargo-binstall will just fall back to cargo install.

📜 Checklist

drahnr commented 1 year ago

Will be merged after #299