Finite state machines in rust; bendns fork to add types.
document feature flags
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | rust-fsm/Cargo.toml | 2 |
2 files changed, 14 insertions, 2 deletions
@@ -1,4 +1,4 @@ -# A framework for building finite state machines in Rust +# A framework and a DSL for building finite state machines in Rust [![Documentation][docs-badge]][docs-link] [![Latest Version][crate-badge]][crate-link] @@ -30,6 +30,18 @@ of state machines: * A Moore machine by providing an output function that do not depend on the provided inputs. +## Feature flags + +### Default + +- `std` - implement features that require the `std` environment. See below. +- `dsl` - re-export `rust-fsm-dsl` from `rust-fsm`. Recommended to leave this on + for the best development experience. + +### Non-default + +- `diagram` - generate Mermaid state diagrams in the doc strings. See below. + ## Usage in `no_std` environments This library has the feature named `std` which is enabled by default. You diff --git a/rust-fsm/Cargo.toml b/rust-fsm/Cargo.toml index 1a6962e..c2cc933 100644 --- a/rust-fsm/Cargo.toml +++ b/rust-fsm/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rust-fsm" -description = "A framework for building finite state machines in Rust" +description = "A framework and a DSL for building finite state machines in Rust" repository = "https://github.com/eugene-babichenko/rust-fsm" homepage = "https://github.com/eugene-babichenko/rust-fsm" documentation = "https://docs.rs/rust-fsm/" |