Skip to content

EmNudge/watlings

Repository files navigation

Watlings

Learn the WebAssembly Text Format
by fixing a bunch of small programs!


Button Roadmap


Example Exercise


Usage

This project uses Node 16+ & NPM for compilation and testing.


Clone the repository and install dependencies with:

git clone git@github.com:EmNudge/watlings.git
cd watlings
npm install

Complete lessons by following the instructions in each exercise within the exercises directory.

Test your answer to an exercise with the start command:

npm start 001_hello

If you'd like to view the solution to an exercise, use the show command:

npm run show 001_hello

To apply it directly to the exercise, use solve instead of show:

npm run solve 001_hello

Recommended Editor

We recommend using VSCode with the WATI extension.

This should provide syntax highlighting, intellisense, and other helpful features as you work through the exercises.

Using Wat2Wasm Directly (Recommended)

To compile your WAT code, we use NPM WABT.

For syntax highlighting and up-to-date builds, you can optionally use the official WebAssembly Binary Toolkit which will provide you with a wat2wasm CLI tool. If it is found on your path as wat2wasm, it will be used instead.

While it is strictly optional, it can help with debugging.


Motivations

I've found just diving in to be the best way to build experience with programming.

Rustlings & Ziglings have both had tremendous returns to my journeys with both languages.

WebAssembly (and by extension WAT) has a more sparse educational landscape than most and I was hoping to fill some of the gaps by building a project with the same sort of structure.


Pedagogical Philosophy

Outlined here are some thoughts on what makes a good teaching experience.

Typing Over Reading

The goal is to learn by doing. Comments on each file outline a task and some background. However, a lot about a language can be gleaned by its syntax alone. We should be adding as little explanation as possible.

Occasional gaps in knowledge can be filled by consistent exposure to the syntax within different contexts. Certain things can therefore be learned without any mention.

Introduction text is superfluous. Words add visual noise, so we should be careful with our count. Coding itself should supplement ambiguities in the text.

If you find a text confusing or too verbose, please create a discussion post!

Create Struggle

Studies have shown that one cannot learn effectively without effort. This applies to practically every domain of knowledge. These projects should be educational, not easy.

This does not mean we should make the education itself elusive. We should not make learning more difficult, but instead more intentional.

When introducing a lot of new syntax, keep the problem scope small, but force the user to read a bit. If the syntax is not new, increase the problem scope. Maybe many variations of the same task.


Credits