kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity

More info on bin programs.

Browse Source
This commit is contained in:
Stephen Chung 2020-12-31 22:11:16 +08:00
parent 8f7a588ac3
commit 70f79d5402
1 changed files with 37 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/src/start/bin.md
View File

@ -10,8 +10,43 @@ A number of Rhai-driven utility programs can be found in the `src/bin` directory
| [`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 |
`rhai-repl` is particularly useful – it allows one to interactively try out Rhai's
language features in a standard REPL (**R**ead-**E**val-**P**rint **L**oop).
`rhai-repl` – The Rhai REPL Tool
-------------------------------------
`rhai-repl` is a particularly useful utility program – it allows one to interactively
try out Rhai's language features in a standard REPL (**R**ead-**E**val-**P**rint **L**oop).
Filenames passed to it as command line arguments are run and loaded before the REPL starts.
### Example
The following command first runs three scripts – `init1.rhai`, `init2.rhai` and
`init3.rhai` – loading the functions defined in each script into the _global_
namespace.
Then it enters an REPL, which can call the above functions freely.
```bash
rhai-repl init1.rhai init2.rhai init3.rhai
```
`rhai-run` – The Rhai Runner
---------------------------------
Use `rhai-run` to run Rhai scripts.
Filenames passed to it as command line arguments are run in sequence.
### Example
The following command runs the scripts `script1.rhai`, `script2.rhai` and `script3.rhai`
in order.
```bash
rhai-run script1.rhai script2.rhai script3.rhai
```
Running a Utility Program