Update README

This commit is contained in:
Tony Garnock-Jones 2021-05-12 15:24:01 +02:00
parent 25698ce4b0
commit 27403776dc
1 changed files with 17 additions and 2 deletions

View File

@ -5,14 +5,29 @@ TypeScript and JavaScript, in both node.js and the browser. The
implementation techniques herein are the subject of a forthcoming
paper.
**IMPORTANT: Use branch `typescript1` when cloning this project from git.**
## Branches
The `main` branch is where active development happens:
git clone -b main https://git.syndicate-lang.org/syndicate-lang/syndicate-js
An earlier TypeScript+JavaScript implementation from early 2021 (the
primary difference to `main` being a lack of object-capability
support) can be found on the `typescript1` branch:
git clone -b typescript1 https://git.syndicate-lang.org/syndicate-lang/syndicate-js
The `main` branch is under active development, and is quite a different system.
Finally, the `babel-based` branch is from 2018, and is an
implementation for JavaScript only. It extends babel with new syntax
and new plugins, (rather than implementing its own error-tolerant
parser, like `typescript1` and `main`):
git clone -b babel-based https://git.syndicate-lang.org/syndicate-lang/syndicate-js
## Building
*These instructions are for the `main` branch.*
This project uses [`yarn`](https://yarnpkg.com/), not `npm`.
The repository is a monorepo, using