Add info into README's.

schungx · Apr 12, 2023 · 094eb58 · 094eb58
1 parent 0206f77
commit 094eb58
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 16 deletions.
diff --git a/src/README.md b/src/README.md
@@ -11,21 +11,23 @@ Root Sources
 | `tokenizer.rs` | Script tokenizer/lexer                                                          |
 | `parser.rs`    | Script parser                                                                   |
 | `optimizer.rs` | Script optimizer                                                                |
+| `defer.rs`     | Utilities for deferred clean-up of resources                                    |
 | `reify.rs`     | Utilities for making generic types concrete                                     |
-| `tests.rs`     | Unit tests (not integration tests, which are in the `rhai/tests` sub-directory) |
+| `tests.rs`     | Unit tests (not integration tests, which are in the main `tests` sub-directory) |
 
 
 Sub-Directories
 ---------------
 
-| Sub-directory | Description                                           |
-| ------------- | ----------------------------------------------------- |
-| `types`       | Common data types (e.g. `Dynamic`, errors)            |
-| `api`         | Public API for the scripting engine                   |
-| `ast`         | AST definition                                        |
-| `module`      | Support for modules                                   |
-| `packages`    | Pre-defined packages                                  |
-| `func`        | Support for function calls                            |
-| `eval`        | Evaluation engine                                     |
-| `serde`       | Support for [`serde`](https://crates.io/crates/serde) |
-| `bin`         | Pre-built CLI binaries (e.g. `rhai-run`, `rhai-repl`) |
+| Sub-directory | Description                                                        |
+| ------------- | ------------------------------------------------------------------ |
+| `config`      | Configuration                                                      |
+| `types`       | Common data types (e.g. `Dynamic`, errors)                         |
+| `api`         | Public API for the scripting engine                                |
+| `ast`         | AST definition                                                     |
+| `module`      | Support for modules                                                |
+| `packages`    | Pre-defined packages                                               |
+| `func`        | Registering and calling functions (native Rust and script-defined) |
+| `eval`        | AST evaluation                                                     |
+| `serde`       | Support for [`serde`](https://crates.io/crates/serde) and metadata |
+| `bin`         | Pre-built CLI binaries                                             |
diff --git a/tools/README.md b/tools/README.md
@@ -1,7 +1,9 @@
 Build Tools
 ===========
 
-| File           | Description                                 |
-| -------------- | ------------------------------------------- |
-| `keywords.txt` | Input file for GNU gperf for the tokenizer. |
-| `reserved.txt` | Input file for GNU gperf for the tokenizer. |
+This directory contains input files for various build tools required for building Rhai.
+
+| File           | Build tool  | Description                                                        |
+| -------------- | :---------: | ------------------------------------------------------------------ |
+| `keywords.txt` | GNU `gperf` | Input file for the tokenizer &ndash; keywords recognition.         |
+| `reserved.txt` | GNU `gperf` | Input file for the tokenizer &ndash; reserved symbols recognition. |