actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-04-20 12:38:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: fix grammatical error (#386)

Browse source
This commit is contained in:
azzamsa 2022-09-16 09:55:19 +07:00 • committed by GitHub
parent a5ffba1ffb
commit a611b824fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -13,7 +13,7 @@ To support `binstall` maintainers must add configuration values to `Cargo.toml`
## Installation ## Installation
To get started _using_ `cargo-binstall` first install the binary (either via `cargo install cargo-binstall` or by downloading a pre-compiled [release](https://github.com/cargo-bins/cargo-binstall/releases)). We recommend using the pre-compiled ones because we optimise those more than a standard source build does. To get started _using_ `cargo-binstall` first install the binary (either via `cargo install cargo-binstall` or by downloading a pre-compiled [release](https://github.com/cargo-bins/cargo-binstall/releases)). We recommend using the pre-compiled ones because we optimize those more than a standard source build does.
| OS | Arch | URL | | OS | Arch | URL |
| ------- | ------- | ------------------------------------------------------------ | | ------- | ------- | ------------------------------------------------------------ |
@ -71,9 +71,9 @@ $ cargo binstall broot --pkg-url="https://github.com/Canop/broot/releases/downlo
and often putting together actual _packages_ is overkill. and often putting together actual _packages_ is overkill.
- Why use the cargo manifest? - Why use the cargo manifest?
- Crates already have these, and they already contain a significant portion of the required information. - Crates already have these, and they already contain a significant portion of the required information.
Also there's this great and woefully underused (imo) `[package.metadata]` field. Also, there's this great and woefully underused (IMO) `[package.metadata]` field.
- Is this secure? - Is this secure?
- Yes and also no? We're not (yet? [#1](https://github.com/cargo-bins/cargo-binstall/issues/1)) doing anything to verify the CI binaries are produced by the right person / organisation. - Yes and also no? We're not (yet? [#1](https://github.com/cargo-bins/cargo-binstall/issues/1)) doing anything to verify the CI binaries are produced by the right person/organization.
However, we're pulling data from crates.io and the cargo manifest, both of which are _already_ trusted entities, and this is However, we're pulling data from crates.io and the cargo manifest, both of which are _already_ trusted entities, and this is
functionally a replacement for `curl ... | bash` or `wget`-ing the same files, so, things can be improved but it's also fairly moot functionally a replacement for `curl ... | bash` or `wget`-ing the same files, so, things can be improved but it's also fairly moot
- What do the error codes mean? - What do the error codes mean?

10
SUPPORT.md
View file

@ -32,7 +32,7 @@ Template variables use the format `{ VAR }` where `VAR` is the name of the varia
- `target` is the rust target name (defaults to your architecture, but can be overridden using the `--target` command line option if required() - `target` is the rust target name (defaults to your architecture, but can be overridden using the `--target` command line option if required()
- `archive-format` is the filename extension of the package archive format - `archive-format` is the filename extension of the package archive format
- `binary-ext` is the string `.exe` if the `target` is for Windows, or the empty string otherwise - `binary-ext` is the string `.exe` if the `target` is for Windows, or the empty string otherwise
- `format` is a soft-deprecated alias for `archive-format` in `pkg-url`, and for `binary-ext` in `bin-dir`; in the future this may warn at install time. - `format` is a soft-deprecated alias for `archive-format` in `pkg-url`, and alias for `binary-ext` in `bin-dir`; in the future, this may warn at install time.
`pkg-url`, `pkg-fmt` and `bin-dir` can be overridden on a per-target basis if required, for example, if your `x86_64-pc-windows-msvc` builds use `zip` archives this could be set via: `pkg-url`, `pkg-fmt` and `bin-dir` can be overridden on a per-target basis if required, for example, if your `x86_64-pc-windows-msvc` builds use `zip` archives this could be set via:
@ -43,7 +43,7 @@ pkg-fmt = "zip"
### Defaults ### Defaults
By default, `binstall` will try all supported package format and would have `bin-dir` set to By default, `binstall` will try all supported package formats and would have `bin-dir` set to
`"{ name }-{ target }-v{ version }/{ bin }{ binary-ext }"` (where `bin` is the cargo binary name and `"{ name }-{ target }-v{ version }/{ bin }{ binary-ext }"` (where `bin` is the cargo binary name and
`binary-ext` is `.exe` on windows and empty on other platforms). `binary-ext` is `.exe` on windows and empty on other platforms).
@ -52,7 +52,7 @@ files are not overwritten when manually executing `tar -xvf ...`).
The default value for `pkg-url` will depend on the repository of the package. The default value for `pkg-url` will depend on the repository of the package.
It is setup to work with github releases, gitlab releases, bitbucket downloads It is set up to work with GitHub releases, GitLab releases, bitbucket downloads
and source forge downloads. and source forge downloads.
If your package already uses any of these URLs, you shouldn't need to set anything. If your package already uses any of these URLs, you shouldn't need to set anything.
@ -91,7 +91,7 @@ feature of GitLab EE: it requires you to create an asset as a link with a
- `{ repo }/downloads/` - `{ repo }/downloads/`
Binaries must be uploaded into the project's "Downloads" page on BitBucket. Binaries must be uploaded to the project's "Downloads" page on BitBucket.
Also note that as there are no per-release downloads, the "versionless" Also note that as there are no per-release downloads, the "versionless"
filename is not considered here. filename is not considered here.
@ -133,7 +133,7 @@ As is common with libraries / utilities (and the `radio-sx128x` example), this c
pkg-url = "{ repo }/releases/download/v{ version }/sx128x-util-{ target }-v{ version }.{ archive-format }" pkg-url = "{ repo }/releases/download/v{ version }/sx128x-util-{ target }-v{ version }.{ archive-format }"
``` ```
Which provides a download URL of: `https://github.com/rust-iot/rust-radio-sx128x/releases/download/v0.14.1-alpha.5/sx128x-util-x86_64-unknown-linux-gnu-v0.14.1-alpha.5.tgz` Which provides a download URL of `https://github.com/rust-iot/rust-radio-sx128x/releases/download/v0.14.1-alpha.5/sx128x-util-x86_64-unknown-linux-gnu-v0.14.1-alpha.5.tgz`
#### If the package structure differs from the default #### If the package structure differs from the default