aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2023-12-05 23:07:35 +0100
committerJohannes Stoelp <johannes.stoelp@gmail.com>2023-12-05 23:07:35 +0100
commit7e98f5def5942969f97f5f015e7fb8417793d132 (patch)
tree7234dbabf5e59b78c7282ade2d1da4228618331f
parentf3d8f8eb16d0da37c84c55fccb5a73b06b2d35d9 (diff)
downloadjuicebox-asm-7e98f5def5942969f97f5f015e7fb8417793d132.tar.gz
juicebox-asm-7e98f5def5942969f97f5f015e7fb8417793d132.zip
update readme to describe examples
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4e22e89..037d8c9 100644
--- a/README.md
+++ b/README.md
@@ -51,5 +51,11 @@ fn main() {
}
```
+The [`examples/`](examples/) folder provides additional examples:
+
+- [`fib.rs`](examples/fib.rs) jit compile a function to compute the `fibonacci` sequence.
+- [`add.rs`](examples/add.rs) jit compile a function calling another function compiled into the example.
+- [`tiny_vm.rs`](examples/tiny_vm.rs.rs) define a minimal `virtual machine (VM)` which demonstrates a simple jit compiler for translating VM guest software.
+
## License
This project is licensed under the [MIT](LICENSE) license.