Getting Started with Braid
This is an example-based introduction to programming with static staging. It describes the static staging compiler, its basic language Braid, and its graphics-centric extended language BraidGL.
Build and Run
To get the compiler running, install Node and npm. Then, on Unix, just type
make to install the dependencies and build the project. Or you can run these commands manually:
$ npm install $ npm run build
Then, you can install the
braid command-line program by typing:
$ npm link
To make sure it's working, you can try running an example:
$ braid test/basic/add.ss
braid -h for usage. The most important options are:
evaland print the output. Together,
-cxshould give you the same output as running the interpreter (with no options at all).
-w: Use the WebGL language extension. (Only valid in compiler mode.)
-v for debugging output and
-g for program generation, as described in the language overview.
There's also an interactive browser frontend. On Unix, just type
make in the
dingus directory. This recipe also requires sassc to compile the CSS for the dingus. Then, open
index.html in your browser.
The dingus seems to work in current versions of Safari, Firefox, Chrome, and Microsoft Edge.
The WebGL examples use some assets (meshes, textures, etc.). First, you can download (most of) these assets by going into the
dingus/assets directory and typing
Make. (See the
Makefile for the URLs and instructions for expanding the files.) Then, because asset loading can't work on a
file:/// URL, you'll need to run a Web server. For example, you can go into the
dingus directory and run
python3 -m http.server.