diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 10 insertions, 14 deletions
@@ -55,8 +55,6 @@ - 📖 [docs.rs](https://docs.rs/mingling/latest/mingling/) - 📖 Helpdoc [EN](https://mingling-rs.github.io/mingling/docs/doc.html#/) [中文](https://mingling-rs.github.io/mingling/docs/_zh_CN/index.html#/) - - <h1 align="center"> Getting Started </h1> @@ -102,11 +100,11 @@ User Input → [Dispatcher] → Entry → [Chain(s)] → Result → [Renderer] **Step4: Render** — A **Renderer** takes that result and writes it to the terminal. > [!NOTE] -> A Chain can produce a **State** type to be passed to the next Chain for further processing, +> A Chain can produce a **State** type to be passed to the next Chain for further processing, > -> or it can produce a **Result** type to be handed off to a Renderer. +> or it can produce a **Result** type to be handed off to a Renderer. -Everything in this pipeline is a **plain Rust function** with an attribute macro on top. +Everything in this pipeline is a **plain Rust function** with an attribute macro on top. You never need to manually implement traits or construct boilerplate. @@ -362,11 +360,9 @@ fn main() { In your `build.rs`, generate the shell scripts: ```rust +// BUILD TIME // Features: ["comp", "builds"] - -fn main() { - mingling::build::build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap(); -} +mingling::build::build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap(); ``` For enum-based completions, use `suggest_enum!`: @@ -829,7 +825,7 @@ Hello, Alice! 🗺️ Roadmap 🗺️ </h1> -- [ ] Milestone.1 "MVP" +- [x] Milestone.1 "MVP" 🎉 - [x] [[0.1.4](https://docs.rs/mingling/0.1.4/mingling/)] [`core`] [`structural_renderer`] **Mingling** can render data into serializable formats via `--json` and `--yaml` flags - [x] [[0.1.5](https://docs.rs/mingling/0.1.5/mingling/)] [`core`] [`comp`] **Mingling** can dynamically invoke itself to provide completions for shells like `bash`, `zsh`, `fish`, and `pwsh` - [x] [[0.1.6](https://docs.rs/mingling/0.1.6/mingling/)] [`core`] [`comp`] **Mingling** can gather more context for smarter completions @@ -839,12 +835,12 @@ Hello, Alice! - [x] [[0.1.8](https://docs.rs/mingling/0.1.8/mingling/)] [`core`] [`dispatch_tree`] Converts the subcommand list into a prefix tree to improve command matching speed - [x] [[0.1.9](https://docs.rs/mingling/0.1.9/mingling/)] [`core`] [`dev_toolkits`] Provides debugging interfaces for developers to capture invocation information when issues arise (`InvokeStackDisplay`) (indirectly implemented via `ProgramHook`) - [x] [[0.1.9](https://docs.rs/mingling/0.1.9/mingling/)] [`core`] [`repl`] Provides REPL capability (`program.exec_repl();`) - - [ ] [**0.2.0**] Complete documentation, tests, and examples + - [x] [[0.2.0](https://docs.rs/mingling/0.2.0/mingling/)] Complete documentation, tests, and examples - [ ] Milestone.2 "More Comfortable Dev and User Experience" - - [ ] [**0.2.1**] [`macros`] `r_println!` in `#[chain]` support. - - [ ] [**0.2.5**] [`mling`] Helpdoc Maker - - [ ] [**0.2.8**] [`picker`] A more efficient and intelligent argument parser + - [ ] [**0.3.0**] [`macros`] `r_println!` in `#[chain]` support. + - [ ] [**0.5.0**] [`mling`] Helpdoc Maker + - [ ] [**0.7.0**] [`picker`] A more efficient and intelligent argument parser - [ ] Milestone.3 "Unplanned" - [ ] ... |