Add README's.

This commit is contained in:
Stephen Chung 2020-10-07 22:56:21 +08:00
parent 0ba219352d
commit d35c216465
6 changed files with 63 additions and 1 deletions

14
benches/README.md Normal file
View File

@ -0,0 +1,14 @@
Micro Benchmarks
================
Micro benchmarks to measure the speed of Rhai.
As with all micro benchmarks, take these with a grain of salt.
How to Run
----------
```bash
cargo +nightly bench
```

View File

@ -3,7 +3,7 @@ name = "rhai_codegen"
version = "0.1.0"
edition = "2018"
authors = ["jhwgh1968"]
description = "Proceducral macro support package for Rhai, a scripting language for Rust"
description = "Procedural macro support package for Rhai, a scripting language for Rust"
homepage = "https://schungx.github.io/rhai/plugins/index.html"
repository = "https://github.com/jonathandturner/rhai"
license = "MIT OR Apache-2.0"

4
codegen/README.md Normal file
View File

@ -0,0 +1,4 @@
Procedural Macros for Plugins
============================
This crate holds procedural macros for code generation, supporting Rhai's plugins system.

12
examples/README.md Normal file
View File

@ -0,0 +1,12 @@
Sample Applications
===================
Sample applications written in Rhai.
How to Run
----------
```bash
cargo run --example sample_app_to_run
```

20
scripts/README.md Normal file
View File

@ -0,0 +1,20 @@
Testing Scripts
===============
Testing scripts written in Rhai.
How to Run
----------
Compile the `rhai_runner` example:
```bash
cargo build --example rhai_runner
```
Run it:
```bash
./target/debug/examples/rhai_runner ./scripts/test_script_to_run.rhai
```

12
tests/README.md Normal file
View File

@ -0,0 +1,12 @@
Tests
=====
Rhai engine tests.
How to Run
----------
```bash
cargo test
```