From 9feb4143246c85caf922a4b2e5feea22039ce52d Mon Sep 17 00:00:00 2001 From: svartalf Date: Fri, 13 Sep 2019 00:21:16 +0300 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9c8e32..33e2f32 100644 --- a/README.md +++ b/README.md @@ -33,4 +33,13 @@ jobs: * `command` (*required*) - Cargo command to run (ex. `check` or `build`) * `toolchain` - Rust toolchain to use (without the `+` sign, ex. `nightly`) * `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.