From 094eb5878ad3bfc02bc1da20366de93c9ea865eb Mon Sep 17 00:00:00 2001 From: Stephen Chung Date: Wed, 12 Apr 2023 12:09:14 +0800 Subject: [PATCH] Add info into README's. --- src/README.md | 26 ++++++++++++++------------ tools/README.md | 10 ++++++---- 2 files changed, 20 insertions(+), 16 deletions(-) diff --git a/src/README.md b/src/README.md index fc1d7bbf..e02fd0b2 100644 --- 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 index ff8fe844..9b96f6cc 100644 --- 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 – keywords recognition. | +| `reserved.txt` | GNU `gperf` | Input file for the tokenizer – reserved symbols recognition. |