aboutsummaryrefslogtreecommitdiff
path: root/mingling_core/src/docs/build.md
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-08-03 00:39:54 +0800
committer魏曹先生 <1992414357@qq.com>2026-08-03 00:39:54 +0800
commitb9d5d8e2c442d73245b66c585afde8846c38d9c1 (patch)
tree1b11da7fabcb16b24272c30ee7aa781c25933ef7 /mingling_core/src/docs/build.md
parent3668b49c0d3423f1d5d10bb6b4a0e0e7b61f2046 (diff)
feat(build): document build module and refine feature exports
Add module-level docs for the build module via include_str and restrict public re-exports to explicit items instead of glob imports.
Diffstat (limited to 'mingling_core/src/docs/build.md')
-rw-r--r--mingling_core/src/docs/build.md14
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
+]
+```