Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #48

Closed
wants to merge 1 commit into from
Closed

Update README.md #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Verona Dynamic Language experiment
# FrankenScript Dynamic Language experiment

This repository contains a toy programming language called "FrankenScript" with Python-like syntax and Python/JavaScript-inspired semantics.
The purpose of FrankenScript is to explore the design space for adding a region-based ownership system inspired by [Reggio](https://doi.org/10.1145/3622846) and a concurrency
model inspired by [behaviour-oriented concurrency](https://doi.org/10.1145/3622852) to dynamic programming languages to unlock parallelism in a way that is free from data-races
(and also deadlocks, if the full behaviour-oriented concurrency model is adopted). FrankenScript is implemented using [Trieste](https://doi.org/10.1145/3687997.3695647).
To this end, FrankenScript programs generate a file called `mermaid.md` with a Mermaid diagram per line in the source program showing the object and region
graph of the program at that program point.

## Pre-requisites

Expand Down Expand Up @@ -31,15 +37,15 @@ ctest
The project can be run by

```bash
./build/verona_dyn build foo.vpy
./build/frank build foo.fs
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I plan to do the binary renaming and test files renaming once #47 has been merged.

I would hold off merging this until the renaming is done. The rest looks good to me :)


where `foo.vpy` is a Verona dynamic language program. This generates a file `mermaid.md` that contains the Mermaid representation of the heap after each step of the program.
where `foo.fs` is a FrankenScript program. This generates a file `mermaid.md` that contains the Mermaid representation of the heap after each step of the program.

You can run in interactive mode by running:

```bash
./build/verona_dyn build --interactive foo.vpy
./build/frank build --interactive foo.fs
```

Which will keep overwritting the `mermaid.md` file with the new heap state after each step.
Which will keep overwritting the `mermaid.md` file with the new heap state after each step.
Loading