From 13a3ba6f7796596e0a16b352f2e01d1329068e18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Hozda?= Date: Sun, 15 Oct 2017 17:48:24 +0200 Subject: [PATCH] add a section about examples to README, add imports to tests.rs --- README.md | 14 ++++++++++++++ src/tests.rs | 3 +++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 846f081c..113e178c 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,20 @@ Other cool projects to check out: * [ChaiScript](http://chaiscript.com/) - A strong inspiration for Rhai. An embedded scripting language for C++ that I helped created many moons ago, now being lead by my cousin. * You can also check out the list of [scripting languages for Rust](http://libs.rs/scripting/) on [libs.rs](http://libs.rs/) +## Examples +The repository contains several examples in the `examples` folder: +- `arrays_and_structs` demonstrates registering a new type to Rhai and the usage of arrays on it +- `custom_types_and_methods` shows how to register a type and methods for it +- `hello` simple example that evaluates an expression and prints the result +- `reuse_scope` evaluates two pieces of code in separate runs, but using a common scope +- `rhai_runner` runs each filename passed to it as a Rhai script +- `simple_fn` shows how to register a Rust function to a Rhai engine + +Examples can be run with the following command: +```bash +cargo run --example name +``` + # Hello world To get going with Rhai, you create an instance of the scripting engine and then run eval. diff --git a/src/tests.rs b/src/tests.rs index dffed5d7..543c13f2 100644 --- a/src/tests.rs +++ b/src/tests.rs @@ -1,3 +1,6 @@ +use engine::{Engine, Scope, EvalAltResult}; +use fn_register::FnRegister; + #[test] fn test_number_literal() { let mut engine = Engine::new();