Skip to content

Commit

Permalink
docs: it was always gonna be Mechanoid
Browse files Browse the repository at this point in the history
Signed-off-by: deadprogram <[email protected]>
  • Loading branch information
deadprogram committed Feb 22, 2024
1 parent d63e0f7 commit 9cac2ce
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# TinyWASM

TinyWASM is a WebAssembly runtime environment for embedded microcontrollers written using TinyGo.
# Mechanoid

Mechanoid is a framework for developing applications using WebAssembly for embedded microcontrollers written using TinyGo.

## How to use

```
mecha new simple
...
(generates new application skeleton)
```

### Simple

Loads an embedded WASM module and then runs it by calling the exported `Ping()` function:
Expand All @@ -16,15 +23,15 @@ import (
_ "embed"
"time"

"github.com/hybridgroup/tinywasm/engine"
"github.com/hybridgroup/tinywasm/interp/wasman"
"github.com/hybridgroup/mechanoid/engine"
"github.com/hybridgroup/mechanoid/interp/wasman"
)

//go:embed ping.wasm
var pingModule []byte

func main() {
println("TinyWASM engine starting...")
println("Mechanoid engine starting...")
eng := engine.NewEngine()

println("Using interpreter...")
Expand Down Expand Up @@ -72,7 +79,7 @@ $ tinygo flash -size short -target pybadge -monitor ./examples/simple
code data bss | flash ram
101012 1736 72216 | 102748 73952
Connected to /dev/ttyACM0. Press Ctrl-C to exit.
TinyWASM engine starting...
Mechanoid engine starting...
Using interpreter...
Initializing engine...
Initializing interpreter...
Expand Down Expand Up @@ -142,7 +149,7 @@ flowchart TD

#### Application

The host application that the developer who uses TinyWASM is creating.
The host application that the developer who uses Mechanoid is creating.

#### Modules

Expand Down

0 comments on commit 9cac2ce

Please sign in to comment.