kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity

Add info into README's.

Browse Source
This commit is contained in:
Stephen Chung 2023-04-12 12:09:14 +08:00
parent 0206f776db
commit 094eb5878a
2 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/README.md
View File

@ -11,21 +11,23 @@ Root Sources
| `tokenizer.rs` | Script tokenizer/lexer | | `tokenizer.rs` | Script tokenizer/lexer |
| `parser.rs` | Script parser | | `parser.rs` | Script parser |
| `optimizer.rs` | Script optimizer | | `optimizer.rs` | Script optimizer |
| `defer.rs` | Utilities for deferred clean-up of resources |
| `reify.rs` | Utilities for making generic types concrete | | `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-Directories
--------------- ---------------
| Sub-directory | Description | | Sub-directory | Description |
| ------------- | ----------------------------------------------------- | | ------------- | ------------------------------------------------------------------ |
| `config` | Configuration |
| `types` | Common data types (e.g. `Dynamic`, errors) | | `types` | Common data types (e.g. `Dynamic`, errors) |
| `api` | Public API for the scripting engine | | `api` | Public API for the scripting engine |
| `ast` | AST definition | | `ast` | AST definition |
| `module` | Support for modules | | `module` | Support for modules |
| `packages` | Pre-defined packages | | `packages` | Pre-defined packages |
| `func` | Support for function calls | | `func` | Registering and calling functions (native Rust and script-defined) |
| `eval` | Evaluation engine | | `eval` | AST evaluation |
| `serde` | Support for [`serde`](https://crates.io/crates/serde) | | `serde` | Support for [`serde`](https://crates.io/crates/serde) and metadata |
| `bin` | Pre-built CLI binaries (e.g. `rhai-run`, `rhai-repl`) | | `bin` | Pre-built CLI binaries |

10
tools/README.md
View File

@ -1,7 +1,9 @@
Build Tools Build Tools
=========== ===========
| File | Description | This directory contains input files for various build tools required for building Rhai.
| -------------- | ------------------------------------------- |
| `keywords.txt` | Input file for GNU gperf for the tokenizer. | | File | Build tool | Description |
| `reserved.txt` | Input file for GNU gperf for the tokenizer. | | -------------- | :---------: | ------------------------------------------------------------------ |
| `keywords.txt` | GNU `gperf` | Input file for the tokenizer – keywords recognition. |
| `reserved.txt` | GNU `gperf` | Input file for the tokenizer – reserved symbols recognition. |