Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sskeirik committed Dec 11, 2024
1 parent 752ff4f commit 7095d45
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,12 @@ To locally build the ULM-integrated version of the semantics, run:
make ULM_TEST=1 ulm-wasm
```

To build the remote ULM-integrated version of the semantics, run:

```sh
make ulm-wasm
```

### Media and documents

The `media/` directory contains presentations and reports about about KWasm.
Expand All @@ -171,6 +177,8 @@ The target `test` contains all the currently passing tests.
make test
```

### ULM-Integrated Wasm Local Testing

To execute the Wasm VM locally, you can use the `wasm` Poetry script from the repo root as follows:

```sh
Expand All @@ -183,6 +191,25 @@ For example, after locally building the ULM-integrated Wasm, the local build of
poetry -C pykwasm run wasm ./build/wasm pykwasm/src/tests/integration/binary/basic-features.wat -gas:Int=0 -create:Bool=false -entry:String=init
```

### ULM-Integrated Wasm Remote Testing

To execute the Wasm VM remotely, you need to build the ULM by running:

```sh
make ulm-build
```

Then, you can start the ULM locally and load the Wasm VM into it by running:

```sh
./scripts/run-dev-ulm &
./scripts/ulm-load-lang ./build/lib/libwasm.so
```

Then, you can invoke Wasm programs by doing the following:

**TODO**

Resources
---------

Expand Down

0 comments on commit 7095d45

Please sign in to comment.