add loops and comments and a list of example scripts and how to run them to README
This commit is contained in:
parent
32c252d4d2
commit
1b22cab7dd
49
README.md
49
README.md
@ -44,6 +44,29 @@ Examples can be run with the following command:
|
|||||||
cargo run --example name
|
cargo run --example name
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Example Scripts
|
||||||
|
We also have a few examples scripts that showcase Rhai's features, all stored in the `scripts` folder:
|
||||||
|
- `array.rhai` - arrays in Rhai
|
||||||
|
- `assignment.rhai` - variable declarations
|
||||||
|
- `comments.rhai` - just comments
|
||||||
|
- `function_decl1.rhai` - a function without parameters
|
||||||
|
- `function_decl2.rhai` - a function with two parameters
|
||||||
|
- `function_decl3.rhai` - a function with many parameters
|
||||||
|
- `if1.rhai` - if example
|
||||||
|
- `loop.rhai` - endless loop in Rhai, this example emulates a do..while cycle
|
||||||
|
- `op1.rhai` - just a simple addition
|
||||||
|
- `op2.rhai` - simple addition and multiplication
|
||||||
|
- `op3.rhai` - change evaluation order with parenthesis
|
||||||
|
- `speed_test.rhai` - a simple program to measure the speed of Rhai's interpreter
|
||||||
|
- `string.rhai`- string operations
|
||||||
|
- `while.rhai` - while loop
|
||||||
|
|
||||||
|
To run the scripts, you can either make your own tiny program, or make use of the `rhai_runner`
|
||||||
|
example program:
|
||||||
|
```bash
|
||||||
|
cargo run --example rhai_runner scripts/any_script.rhai
|
||||||
|
```
|
||||||
|
|
||||||
# Hello world
|
# Hello world
|
||||||
|
|
||||||
To get going with Rhai, you create an instance of the scripting engine and then run eval.
|
To get going with Rhai, you create an instance of the scripting engine and then run eval.
|
||||||
@ -290,6 +313,17 @@ while x > 0 {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Loop
|
||||||
|
```rust
|
||||||
|
let x = 10;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
print(x);
|
||||||
|
x = x - 1;
|
||||||
|
if x == 0 { break; }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
Rhai supports defining functions in script:
|
Rhai supports defining functions in script:
|
||||||
@ -337,3 +371,18 @@ let name = "Bob";
|
|||||||
let middle_initial = 'C';
|
let middle_initial = 'C';
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Comments
|
||||||
|
|
||||||
|
```rust
|
||||||
|
let /* intruder comment */ name = "Bob";
|
||||||
|
// This is a very important comment
|
||||||
|
/* This comment spans
|
||||||
|
multiple lines, so it
|
||||||
|
only makes sense that
|
||||||
|
it is even more important */
|
||||||
|
|
||||||
|
/* Fear not, Rhai satisfies all your nesting
|
||||||
|
needs with nested comments:
|
||||||
|
/*/*/*/*/**/*/*/*/*/
|
||||||
|
*/
|
||||||
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user