From 03897c74e4f5b56617f6070526855c5a1d86f1eb Mon Sep 17 00:00:00 2001 From: Taiki Endo Date: Tue, 4 Jun 2024 04:03:00 +0900 Subject: [PATCH] Tweak docs --- README.md | 6 +----- TOOLS.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6882ac24..1839e31f 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,7 @@ Or: See [TOOLS.md](TOOLS.md) for the list of tools that are installed from manifests managed in this action. -If `$CARGO_HOME/bin` is not available, Rust-related binaries will be installed to `$HOME/.cargo/bin`.
-If `$HOME/.cargo/bin` is not available, Rust-related binaries will be installed to `/usr/local/bin`.
-If `/usr/local/bin` is not available, binaries will be installed to `$HOME/.install-action/bin`.
- -**If a tool not included in the list above is specified, this action uses [cargo-binstall] as a fallback.** +If a tool not included in the list above is specified, this action uses [cargo-binstall] as a fallback. ### Add support for new tool diff --git a/TOOLS.md b/TOOLS.md index 8846880e..aae49dff 100644 --- a/TOOLS.md +++ b/TOOLS.md @@ -1,5 +1,13 @@ # Tools +This is a list of tools that are installed from manifests managed in this action. + +If a tool not included in the list below is specified, this action uses [cargo-binstall] as a fallback. + +> If `$CARGO_HOME/bin` is not available, Rust-related binaries will be installed to `$HOME/.cargo/bin`.
+> If `$HOME/.cargo/bin` is not available, Rust-related binaries will be installed to `/usr/local/bin`.
+> If `/usr/local/bin` is not available, binaries will be installed to `$HOME/.install-action/bin`.
+ | Name | Where binaries will be installed | Where will it be installed from | Supported platform | License | | ---- | -------------------------------- | ------------------------------- | ------------------ | ------- | | [**biome**](https://biomejs.dev) | `/usr/local/bin` | [GitHub Releases](https://github.com/biomejs/biome/releases) | Linux, macOS, Windows | [Apache-2.0](https://github.com/biomejs/biome/blob/main/LICENSE-APACHE) OR [MIT](https://github.com/biomejs/biome/blob/main/LICENSE-MIT) | @@ -47,3 +55,5 @@ | [**wasmtime**](https://github.com/bytecodealliance/wasmtime) | `$CARGO_HOME/bin` | [GitHub Releases](https://github.com/bytecodealliance/wasmtime/releases) | Linux, macOS, Windows | [Apache-2.0 WITH LLVM-exception](https://github.com/bytecodealliance/wasmtime/blob/main/LICENSE) | | [**xbuild**](https://github.com/rust-mobile/xbuild) | `$CARGO_HOME/bin` | [GitHub Releases](https://github.com/rust-mobile/xbuild/releases) | Linux, macOS, Windows | [Apache-2.0 OR MIT](https://github.com/rust-mobile/xbuild/blob/268939a99a50d7927bce3e343e5d2ed32eb8b30e/xbuild/Cargo.toml#L7) | | [**zola**](https://github.com/getzola/zola) | `$CARGO_HOME/bin` | [GitHub Releases](https://github.com/getzola/zola/releases) | Linux, macOS, Windows | [MIT](https://github.com/getzola/zola/blob/master/LICENSE) | + +[cargo-binstall]: https://github.com/cargo-bins/cargo-binstall