diff options
Diffstat (limited to 'mingling_core/src/docs')
| -rw-r--r-- | mingling_core/src/docs/build.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/mingling_core/src/docs/build.md b/mingling_core/src/docs/build.md new file mode 100644 index 0000000..dac3778 --- /dev/null +++ b/mingling_core/src/docs/build.md @@ -0,0 +1,14 @@ +Provides Mingling's build script module, used in `build.rs` to provide build-time behavior for certain features. + +To use it, add the following to your `Cargo.toml` under `[build-dependencies]`, and enable the features +that require build-time behavior from the crate: + +```toml +# Cargo.toml +[build-dependencies.mingling] +version = "0.3.0" +features = [ + "build", # Enable it + "comp", # If you need completion-related build-time behavior, enable this as well +] +``` |