From 66012f9787e81791fcf8a917b6c5b135313803fd Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Wed, 2 Mar 2022 11:19:35 +0100 Subject: [PATCH] Update the bundler xtask and cargo subcommand docs --- cargo_nih_plug/README.md | 9 +++++---- nih_plug_xtask/README.md | 7 ++++--- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/cargo_nih_plug/README.md b/cargo_nih_plug/README.md index a00742b2..53c14ed6 100644 --- a/cargo_nih_plug/README.md +++ b/cargo_nih_plug/README.md @@ -1,8 +1,9 @@ # NIH-plug: cargo subcommand for bundling plugins -This is NIH-plug's `cargo xtask` command, as a `cargo` subcommand. This way you -can use it outside of NIH-plug projects. If you're using NIH-plug, you'll want -to use the xtask integration directly instead, see: +This is NIH-plug's `cargo xtask` command, but as a `cargo` subcommand. This way +you can use it outside of NIH-plug projects. If you're using NIH-plug, you'll +want to use the xtask integration directly instead so you don't need to worry +about keeping the command up to date, see: . Since this has not yet been published to `crates.io`, you'll need to install @@ -12,7 +13,7 @@ this using: cargo install --git https://github.com/robbert-vdh/nih-plug.git cargo-nih-plug ``` -Once that's installed, you can bundle plugins using: +Once that's installed, you can compile and bundle plugins using: ```shell cargo nih-plug bundle --release diff --git a/nih_plug_xtask/README.md b/nih_plug_xtask/README.md index 46b14efa..d12ffdd0 100644 --- a/nih_plug_xtask/README.md +++ b/nih_plug_xtask/README.md @@ -1,9 +1,10 @@ # NIH-plug: bundler and other utilities This is NIH-plug's `cargo xtask` command, but as a library. This way you can use -it in your own projects without forking this repo or copying the binary into -your own repo. This is necessary until Cargo supports [running binaries from -dependencies directly](https://github.com/rust-lang/rfcs/pull/3168). +it in your own projects without having to either fork this repo or vendor the +binary into your own repo. This is necessary until Cargo supports [running +binaries from dependencies +directly](https://github.com/rust-lang/rfcs/pull/3168). To use this, add an `xtask` binary to your project using `cargo new --bin xtask` and add it to the Cargo workspace in your repository's main `Cargo.toml` file: