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
Download Patch File Download Diff File Expand all files Collapse all files

26
src/README.md
View File

@@ -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 |