From 3db918e89a860b700652fbef764e7057d0805897 Mon Sep 17 00:00:00 2001 From: Stephen Chung Date: Tue, 15 Feb 2022 19:56:42 +0800 Subject: [PATCH] Doc fixup. --- README.md | 2 +- src/bin/README.md | 23 ++++++++++++++--------- src/bin/rhai-dbg.rs | 1 + 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 257072c6..f64d937b 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Standard features * Fairly efficient evaluation (1 million iterations in 0.3 sec on a single-core, 2.3 GHz Linux VM). * Tight integration with native Rust [functions](https://rhai.rs/book/rust/functions.html) and [types]([#custom-types-and-methods](https://rhai.rs/book/rust/custom.html)), including [getters/setters](https://rhai.rs/book/rust/getters-setters.html), [methods](https://rhai.rs/book/rust/custom.html) and [indexers](https://rhai.rs/book/rust/indexers.html). * Freely pass Rust values into a script as [variables](https://rhai.rs/book/language/variables.html)/[constants](https://rhai.rs/book/language/constants.html) via an external [`Scope`](https://rhai.rs/book/rust/scope.html) - all clonable Rust types are supported; no need to implement any special trait. Or tap directly into the [variable resolution process](https://rhai.rs/book/engine/var.html). -* Built-in support for most common [data types](https://rhai.rs/book/language/values-and-types.html) including booleans, [integers](https://rhai.rs/book/language/numbers.html), [floating-point numbers](https://rhai.rs/book/language/numbers.html) (including [`Decimal`](https://crates.io/crates/rust_decimal)), [strings](https://rhai.rs/book/language/strings-chars.html), [Unicode characters](https://rhai.rs/book/language/strings-chars.html), [arrays](https://rhai.rs/book/language/arrays.html) and [object maps](https://rhai.rs/book/language/object-maps.html). +* Built-in support for most common [data types](https://rhai.rs/book/language/values-and-types.html) including booleans, [integers](https://rhai.rs/book/language/numbers.html), [floating-point numbers](https://rhai.rs/book/language/numbers.html) (including [`Decimal`](https://crates.io/crates/rust_decimal)), [strings](https://rhai.rs/book/language/strings-chars.html), [Unicode characters](https://rhai.rs/book/language/strings-chars.html), [arrays](https://rhai.rs/book/language/arrays.html) (including packed [byte arrays](https://rhai.rs/book/language/blobs.html)) and [object maps](https://rhai.rs/book/language/object-maps.html). * Easily [call a script-defined function](https://rhai.rs/book/engine/call-fn.html) from Rust. * Relatively little `unsafe` code (yes there are some for performance reasons). * Few dependencies - currently only [`smallvec`](https://crates.io/crates/smallvec), [`num-traits`](https://crates.io/crates/num-traits), [`ahash`](https://crates.io/crates/ahash) and [`smartstring`](https://crates.io/crates/smartstring). diff --git a/src/bin/README.md b/src/bin/README.md index 32ba31ae..1480589c 100644 --- a/src/bin/README.md +++ b/src/bin/README.md @@ -1,16 +1,21 @@ Rhai Tools ========== -Tools for running Rhai scripts. +Tools for working with Rhai scripts. -| Tool | Required feature(s) | Description | -| -------------------------------------------------------------------------------- | :-----------------: | --------------------------------------------------- | -| [`rhai-run`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-run.rs) | | runs each filename passed to it as a Rhai script | -| [`rhai-repl`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-repl.rs) | `rustyline` | simple REPL that interactively evaluates statements | -| [`rhai-dbg`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-dbg.rs) | `debugging` | the _Rhai Debugger_ | +| Tool | Required feature(s) | Description | +| -------------------------------------------------------------------------------- | :-----------------: | ----------------------------------------------------- | +| [`rhai-run`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-run.rs) | | runs each filename passed to it as a Rhai script | +| [`rhai-repl`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-repl.rs) | `rustyline` | a simple REPL that interactively evaluates statements | +| [`rhai-dbg`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-dbg.rs) | `debugging` | the _Rhai Debugger_ | -There is a feature called `bin-features` which automatically includes all the necessary features -required for building these tools. +For convenience, a feature named `bin-features` is available which is a combination of the following: + +* `decimal` – support for decimal numbers +* `metadata` – access functions metadata +* `serde` – export functions metadata to JSON +* `debugging` – required by `rhai-dbg` +* `rustyline` – required by `rhai-repl` How to Run @@ -33,5 +38,5 @@ cargo install --path . --bins --features bin-features or specifically: ```sh -cargo install --path . --bin rhai-run --features bin-features +cargo install --path . --bin sample_app_to_run --features bin-features ``` diff --git a/src/bin/rhai-dbg.rs b/src/bin/rhai-dbg.rs index c4ee88ca..2fa211aa 100644 --- a/src/bin/rhai-dbg.rs +++ b/src/bin/rhai-dbg.rs @@ -635,6 +635,7 @@ fn main() { // Hook up debugger let lines: Vec<_> = script.trim().split('\n').map(|s| s.to_string()).collect(); + #[allow(deprecated)] engine.register_debugger( // Store the current source in the debugger state || "".into(),