Doc fixup.
This commit is contained in:
@@ -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
|
||||
```
|
||||
|
@@ -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(),
|
||||
|
Reference in New Issue
Block a user