Update the bundler xtask and cargo subcommand docs
This commit is contained in:
parent
9d5de10d16
commit
66012f9787
|
@ -1,8 +1,9 @@
|
||||||
# NIH-plug: cargo subcommand for bundling plugins
|
# NIH-plug: cargo subcommand for bundling plugins
|
||||||
|
|
||||||
This is NIH-plug's `cargo xtask` command, as a `cargo` subcommand. This way you
|
This is NIH-plug's `cargo xtask` command, but as a `cargo` subcommand. This way
|
||||||
can use it outside of NIH-plug projects. If you're using NIH-plug, you'll want
|
you can use it outside of NIH-plug projects. If you're using NIH-plug, you'll
|
||||||
to use the xtask integration directly instead, see:
|
want to use the xtask integration directly instead so you don't need to worry
|
||||||
|
about keeping the command up to date, see:
|
||||||
<https://github.com/robbert-vdh/nih-plug/tree/master/nih_plug_xtask>.
|
<https://github.com/robbert-vdh/nih-plug/tree/master/nih_plug_xtask>.
|
||||||
|
|
||||||
Since this has not yet been published to `crates.io`, you'll need to install
|
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
|
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
|
```shell
|
||||||
cargo nih-plug bundle <package_name> --release
|
cargo nih-plug bundle <package_name> --release
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
# NIH-plug: bundler and other utilities
|
# NIH-plug: bundler and other utilities
|
||||||
|
|
||||||
This is NIH-plug's `cargo xtask` command, but as a library. This way you can use
|
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
|
it in your own projects without having to either fork this repo or vendor the
|
||||||
your own repo. This is necessary until Cargo supports [running binaries from
|
binary into your own repo. This is necessary until Cargo supports [running
|
||||||
dependencies directly](https://github.com/rust-lang/rfcs/pull/3168).
|
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`
|
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:
|
and add it to the Cargo workspace in your repository's main `Cargo.toml` file:
|
||||||
|
|
Loading…
Reference in a new issue