From 24d499e71614e73cce74e96cb8504aee49ebac2a Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Sun, 3 Jul 2022 19:49:20 +0200 Subject: [PATCH] Fix typos in nih_plug_xtask's readme --- nih_plug_xtask/README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/nih_plug_xtask/README.md b/nih_plug_xtask/README.md index ea87b144..266532e1 100644 --- a/nih_plug_xtask/README.md +++ b/nih_plug_xtask/README.md @@ -1,13 +1,13 @@ # 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 having to either fork this repo or vendor the +This is NIH-plug's `cargo xtask` command, as a library. This way you can use 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: +To use this, add an `xtask` binary to your project using `cargo new --bin xtask`. Then add that binary to the Cargo workspace in your repository's main +`Cargo.toml` file like so: ```toml # Cargo.toml @@ -16,7 +16,8 @@ and add it to the Cargo workspace in your repository's main `Cargo.toml` file: members = ["xtask"] ``` -Then add `nih_plug_xtask` to your new xtask package's dependencies: +Add `nih_plug_xtask` to the new xtask package's dependencies, and call its main +function from the new xtask binary: ```toml # xtask/Cargo.toml @@ -25,18 +26,16 @@ Then add `nih_plug_xtask` to your new xtask package's dependencies: nih_plug_xtask = { git = "https://github.com/robbert-vdh/nih-plug.git" } ``` -Call `nih_plug_xtask`'s main function own xtask binary: - ```rust -# xtask/src/main.rs +// xtask/src/main.rs fn main() -> nih_plug_xtask::Result<()> { nih_plug_xtask::main() } ``` -And finally create a `.cargo/config` file in your repository and add a Cargo -alias so you can invoke the binary with `cargo xtask`: +Lastly, create a `.cargo/config` file in your repository and add a Cargo alias. +This allows you to run the binary using `cargo xtask`: ```toml # .cargo/config