concept-collection / numbl-project-example
numbl-project-example / README.md
26 lines · 842 BCodeBlameHistory
33de318Initial commit: numbl project example for GitHub PagesJeremy Magland 1# numbl project example
3A tiny example [numbl](https://numbl.org) project deployed to **GitHub Pages**.
4Everything runs in your browser — pick a script in the panel on the left and
5click **Run**. You can edit any file too; changes stay in memory for your
6session.
8## Files
10- [`main.m`](main.m) — prints a couple of values and draws a plot.
11- [`waves.m`](waves.m) — a small helper function used by `main.m`.
13```matlab
14x = linspace(0, 4*pi, 400);
15plot(x, exp(-x/10) .* sin(x));
16title('damped sine');
17```
19## How it's deployed
21On every push to `main`, the workflow in
22[`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) bundles these
23files with the numbl browser IDE and publishes the result to GitHub Pages — no
24server, nothing to build by hand.
26Edit `numbl-project.json` to change the title or which file opens first.