Update README.md

This commit is contained in:
svartalf 2019-09-13 00:21:16 +03:00 committed by GitHub
parent d73b4029fd
commit 9feb414324
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -33,4 +33,13 @@ jobs:
* `command` (*required*) - Cargo command to run (ex. `check` or `build`) * `command` (*required*) - Cargo command to run (ex. `check` or `build`)
* `toolchain` - Rust toolchain to use (without the `+` sign, ex. `nightly`) * `toolchain` - Rust toolchain to use (without the `+` sign, ex. `nightly`)
* `args` - Arguments for the cargo command * `args` - Arguments for the cargo command
* `use-cross` - Use [cross](https://github.com/rust-embedded/cross) instead of cargo (default: `false`) * `use-cross` - Use [`cross`](https://github.com/rust-embedded/cross) instead of `cargo` (default: `false`)
## Why?
Why is it needed when you can just do the `-run: cargo build` step?
Because it can call [cross](https://github.com/rust-embedded/cross) instead of `cargo`
if needed. If `cross` is not installed, it will be installed automatically on a first call.
In a future this Action might be available to install other cargo subcommands on demand too.