alex/nih-plug
1
0
Fork 0
Code Activity

Fix typos in nih_plug_xtask's readme

Browse source
This commit is contained in:
Robbert van der Helm 2022-07-03 19:49:20 +02:00
parent 52d9fff313
commit 24d499e716
1 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
nih_plug_xtask/README.md
View file

@ -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