aboutsummaryrefslogtreecommitdiff
path: root/docs/_zh_CN/pages/1-getting-started.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_zh_CN/pages/1-getting-started.md')
-rw-r--r--docs/_zh_CN/pages/1-getting-started.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/_zh_CN/pages/1-getting-started.md b/docs/_zh_CN/pages/1-getting-started.md
new file mode 100644
index 0000000..2961464
--- /dev/null
+++ b/docs/_zh_CN/pages/1-getting-started.md
@@ -0,0 +1,69 @@
+<h1 align="center">起步</h1>
+
+## 创建一个新项目
+
+```bash
+cargo new my-cli
+cd my-cli
+```
+
+## 添加依赖
+
+在 `Cargo.toml` 写入如下内容
+
+```toml
+[dependencies.mingling]
+version = "0.2"
+features = []
+```
+
+## 启用特性
+
+**Mingling** 默认所有特性关闭,且不提供类似 `full` 的全开特性。
+
+因为部分特性会 **直接影响整个生命周期的行为**,需要你按需启用,例如:
+
+```toml
+[dependencies.mingling]
+version = "0.2"
+features = [
+ "parser",
+ "comp",
+]
+```
+
+> [!NOTE]
+> 请前往 [docs.rs](https://docs.rs/mingling/latest/mingling/feature/index.html) 或 [特性](pages/other/features) 以了解所有特性
+
+## 编写基本入口
+
+编写 `src/main.rs`,写入以下代码:
+
+```rust
+use mingling::prelude::*;
+
+fn main() {
+ let mut program = ThisProgram::new();
+
+ program.exec_and_exit();
+}
+
+gen_program!();
+```
+
+> [!IMPORTANT]
+> 文档中几乎所有 Rust 代码块都已在 CI 流程中编译通过,可以保证可用性。
+>
+> 但以 `// NOT VERIFIED` 开头的代码块 **未被验证**。
+>
+> 想确认哪些 `*.md` 文件被编译过?请看 [`verified-docs.toml`](https://github.com/mingling-rs/mingling/blob/main/verified-docs.toml)
+
+## 编译验证
+
+```plaintext
+~# cargo check
+```
+
+---
+
+一切无误后,开始写点什么吧!