From d35c216465437b0e9b08ad0f6b0cebf872374690 Mon Sep 17 00:00:00 2001
From: Stephen Chung <Stephen.Chung@intexact.com>
Date: Wed, 7 Oct 2020 22:56:21 +0800
Subject: [PATCH] Add README's.

---
 benches/README.md  | 14 ++++++++++++++
 codegen/Cargo.toml |  2 +-
 codegen/README.md  |  4 ++++
 examples/README.md | 12 ++++++++++++
 scripts/README.md  | 20 ++++++++++++++++++++
 tests/README.md    | 12 ++++++++++++
 6 files changed, 63 insertions(+), 1 deletion(-)
 create mode 100644 benches/README.md
 create mode 100644 codegen/README.md
 create mode 100644 examples/README.md
 create mode 100644 scripts/README.md
 create mode 100644 tests/README.md

diff --git a/benches/README.md b/benches/README.md
new file mode 100644
index 00000000..1c6d87ce
--- /dev/null
+++ b/benches/README.md
@@ -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
+```
diff --git a/codegen/Cargo.toml b/codegen/Cargo.toml
index e8cc0ee5..8a2d3456 100644
--- a/codegen/Cargo.toml
+++ b/codegen/Cargo.toml
@@ -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"
diff --git a/codegen/README.md b/codegen/README.md
new file mode 100644
index 00000000..0625bff9
--- /dev/null
+++ b/codegen/README.md
@@ -0,0 +1,4 @@
+Procedural Macros for Plugins
+============================
+
+This crate holds procedural macros for code generation, supporting Rhai's plugins system.
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 00000000..610f388e
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,12 @@
+Sample Applications
+===================
+
+Sample applications written in Rhai.
+
+
+How to Run
+----------
+
+```bash
+cargo run --example sample_app_to_run
+```
diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 00000000..ca204dd9
--- /dev/null
+++ b/scripts/README.md
@@ -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
+```
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 00000000..c5b5e042
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,12 @@
+Tests
+=====
+
+Rhai engine tests.
+
+
+How to Run
+----------
+
+```bash
+cargo test
+```