Skip to content

Commit

Permalink
Update the README describing the various crates
Browse files Browse the repository at this point in the history
  • Loading branch information
rdaum committed Dec 6, 2024
1 parent fed66f6 commit a76b8b1
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions crates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,20 @@ Binaries:
network `host`s
- `web-host` - like the above, but hosts an HTTP server which provides a websocket interface to the system.
as well as various web APIs.
- `console-host` - console host which connects as a user to the `daemon` and provides a readline-type interface to the
system.
- `model-checker` - a tool for using the `elle` tool from Jepsen for verifying transactional properties of the\
database
- `moot` - a comprensive test suite for verifying the correctness of the MOO implementation, including a battery of
tests ported from ToastStunt.

Libraries:

- `values` - crate that implements the core MOO discriminated union (`Var`) value type,
plus all associated types and traits.
- `rdb` - implementation of a custom in-memory quasi-relational MVCC database system
- `db` - implementation of the `WorldState` object database overtop of `rdb`
- `compiler` - the MOO language grammar, parser, AST, and codegen, as well as the decompiler & unparser
- `kernel` - the kernel of the MOO driver: virtual machine, task scheduler, implementations of all builtin\
functions
- `vm` - the virtual machine, task scheduler, and task queue
- `rpc-common` - provides types & functions used by both `daemon` and each host binary, for the RPC interface
- `rpc-async-client` - provides an async RPC client for the `daemon`'s RPC interface
- `rpc-sync-client` - provides a synchronous RPC client for the `daemon`'s RPC interface

0 comments on commit a76b8b1

Please sign in to comment.