From e1ac6cc90e41be0ea28c16079fc9dc98f0447650 Mon Sep 17 00:00:00 2001 From: Stephen Chung Date: Fri, 25 Dec 2020 16:08:56 +0800 Subject: [PATCH] Change rhai_runner and repl to rhai-run and rhai-repl. --- doc/src/start/examples/rust.md | 6 +++--- doc/src/start/examples/scripts.md | 4 ++-- examples/{repl.rs => rhai-repl.rs} | 0 examples/{rhai_runner.rs => rhai-run.rs} | 0 scripts/README.md | 6 +++--- 5 files changed, 8 insertions(+), 8 deletions(-) rename examples/{repl.rs => rhai-repl.rs} (100%) rename examples/{rhai_runner.rs => rhai-run.rs} (100%) diff --git a/doc/src/start/examples/rust.md b/doc/src/start/examples/rust.md index bd3064c8..0b343a52 100644 --- a/doc/src/start/examples/rust.md +++ b/doc/src/start/examples/rust.md @@ -11,13 +11,13 @@ A number of examples can be found in the `examples` directory: | [`custom_types_and_methods`]({{repoTree}}/examples/custom_types_and_methods.rs) | shows how to register a custom Rust type and methods for it | | [`hello`]({{repoTree}}/examples/hello.rs) | simple example that evaluates an expression and prints the result | | [`reuse_scope`]({{repoTree}}/examples/reuse_scope.rs) | evaluates two pieces of code in separate runs, but using a common [`Scope`] | -| [`rhai_runner`]({{repoTree}}/examples/rhai_runner.rs) | runs each filename passed to it as a Rhai script | +| [`rhai-repl`]({{repoTree}}/examples/rhai-repl.rs) | a simple REPL, interactively evaluate statements from stdin | +| [`rhai-run`]({{repoTree}}/examples/rhai-run.rs) | runs each filename passed to it as a Rhai script | | [`serde`]({{repoTree}}/examples/serde.rs) | example to serialize and deserialize Rust types with [`serde`](https://crates.io/crates/serde).
The [`serde`] feature is required to run | | [`simple_fn`]({{repoTree}}/examples/simple_fn.rs) | shows how to register a simple function | | [`strings`]({{repoTree}}/examples/strings.rs) | shows different ways to register functions taking string arguments | -| [`repl`]({{repoTree}}/examples/repl.rs) | a simple REPL, interactively evaluate statements from stdin | -The `repl` example is a particularly good one as it allows one to interactively try out Rhai's +The `rhai-repl` example is a particularly good one as it allows one to interactively try out Rhai's language features in a standard REPL (**R**ead-**E**val-**P**rint **L**oop). diff --git a/doc/src/start/examples/scripts.md b/doc/src/start/examples/scripts.md index f3167a93..8de664a5 100644 --- a/doc/src/start/examples/scripts.md +++ b/doc/src/start/examples/scripts.md @@ -46,8 +46,8 @@ The following scripts are for benchmarking the speed of Rhai: Running Example Scripts ---------------------- -The [`rhai_runner`](../examples/rust.md) example can be used to run the scripts: +The [`rhai-run`](../examples/rust.md) example can be used to run the scripts: ```bash -cargo run --example rhai_runner scripts/any_script.rhai +cargo run --example rhai-run scripts/any_script.rhai ``` diff --git a/examples/repl.rs b/examples/rhai-repl.rs similarity index 100% rename from examples/repl.rs rename to examples/rhai-repl.rs diff --git a/examples/rhai_runner.rs b/examples/rhai-run.rs similarity index 100% rename from examples/rhai_runner.rs rename to examples/rhai-run.rs diff --git a/scripts/README.md b/scripts/README.md index ca204dd9..f3bf5b4a 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -7,14 +7,14 @@ Testing scripts written in Rhai. How to Run ---------- -Compile the `rhai_runner` example: +Compile the `rhai-run` example: ```bash -cargo build --example rhai_runner +cargo build --example rhai-run ``` Run it: ```bash -./target/debug/examples/rhai_runner ./scripts/test_script_to_run.rhai +./target/debug/examples/rhai-run ./scripts/test_script_to_run.rhai ```