Skip to content

Commit bdcb1bc

Browse files
authored
Update README.md
Unified proposal
1 parent d847ba5 commit bdcb1bc

File tree

1 file changed

+11
-28
lines changed

1 file changed

+11
-28
lines changed

README.md

+11-28
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,27 @@
11
# Stack-Switching Proposal for WebAssembly
22

3-
This repository is a clone of
4-
[`WebAssembly/spec`](https://github.com/WebAssembly/spec/). It is meant for
5-
discussion, prototype specification, and implementation of a proposal to add
3+
This repository is a clone of [`WebAssembly/spec`](https://github.com/WebAssembly/spec/). It is meant for discussion, prototype specification, and implementation of a proposal to add
64
support for stack-switching.
75

8-
There are currently two active stack-switching proposals: Typed Continuations
9-
(aka WasmFX) and Bag of Stacks. Documentation about each proposal is available
10-
in separate directories of the `main` branch of this repository (as detailed
11-
below).
6+
See the [explainer](proposals/stack-switching/Explainer.md) for a high-level summary of the proposal.
127

13-
In order to minimise future difficulties merging upstream, the two
14-
corresponding extensions to the reference interpreter will be
15-
maintained in separate branches (as detailed below).
8+
## Previous proposals
169

17-
## Typed Continuations Proposal
10+
The current explainer represents the unification of two previous proposals: Typed Continuations (wasmfx) and Bag of Stacks (bos). (The explainers have now been unified. Once the reference interpreter and examples are adapted for the unified proposal this section will be removed from the README.)
1811

19-
* See the [explainer](proposals/continuations/Explainer.md) for a high-level
20-
summary of the proposal.
12+
#### Typed Continuations
2113

22-
* See the [overview](proposals/continuations/Overview.md) for a more formal
23-
description of the proposal.
14+
* See the [explainer](proposals/continuations/Explainer.md) for a high-level summary of the proposal.
2415

25-
* See the [examples](proposals/continuations/examples) for Wasm code for
26-
implementing various different features including lightweight threads, actors,
27-
and async/await.
16+
* See the [overview](proposals/continuations/Overview.md) for a more formal description of the proposal.
2817

29-
* An
30-
[implementation](https://github.com/WebAssembly/stack-switching/tree/wasmfx) is
31-
available as an extension to the reference interpreter. It is accesible from the
32-
`wasmfx` branch.
18+
* An [implementation](https://github.com/WebAssembly/stack-switching/tree/wasmfx) is available as an extension to the reference interpreter. It is accesible from the `wasmfx` branch of this repository.
3319

34-
## Bag of Stacks Proposal
20+
* See the [examples](proposals/continuations/examples) for Wasm code for implementing various different features including lightweight threads, actors, and async/await.
3521

36-
* See the [explainer](proposals/bag-o-stacks/Explainer.md) for a high-level
37-
summary of the proposal.
38-
39-
* An extension to the reference interpreter will be made available in the
40-
`bag-o-stacks` branch in due course.
22+
#### Bag of Stacks Proposal
4123

24+
* See the [explainer](proposals/bag-o-stacks/Explainer.md) for a high-level summary of the proposal.
4225

4326
Original README from upstream repository follows.
4427

0 commit comments

Comments
 (0)