Skip to content

docs: README rewrite, logo, and a WASM freshness check - #10

Merged
deaneeth merged 7 commits into
mainfrom
docs/readme-logo-and-ci-check
Oct 27, 2026
Merged

deaneeth merged 7 commits into
mainfrom
docs/readme-logo-and-ci-check

Conversation

@deaneeth

Copy link
Copy Markdown
Member

Rewrites the README in the series style (logo, badges, verified results, FPGA numbers, quick start, related projects), adds the logo and favicon, updates the plan's links to the org, and makes the WASM workflow fail when the committed engine differs from a fresh build.

…dd a WASM freshness check

- README in the series style: logo (light and dark), badges for the four CI workflows, what FlashAttention is,
  hardware, the traffic, cycle and accuracy results from the golden model and baselines, the verification table,
  FPGA numbers, quick start, repo map, docs, roadmap, related projects, references.
- Logo and favicon: the 4x4 causal tile grid in the visualizer's colours.
- docs/PLAN.md: series links point at the tinycomputers org.
- wasm.yml: fail if a fresh build differs from the committed web/public/tiny_attn.{mjs,wasm}.
…yte for byte

The first run failed: the latest Emscripten compiled a different .wasm than the committed build (the JavaScript glue matched).
6.0.13 is the version the committed engine was built with.
The committed engine embedded the local checkout and Verilator install paths, so CI's build (other paths) could never
match byte for byte. Verilator now runs on repo-relative paths and em++ remaps the root and the Verilator install to
fixed names. The same sources now give identical bytes from different directories (checked here), and the rebuilt
engine passes wasm/test.mjs.
… the engine matches byte for byte

The runtime's version string is compiled into the engine. The configure-based build in CI reported a different version than
the CMake build used locally, so the committed engine could not be reproduced in CI. Removes the temporary diagnostic step.
Byte-identical .wasm builds are not reproducible across these machines (CI and this laptop produce different bytes
from the same sources, even with the same Emscripten and a CMake-built Verilator). CI now runs the golden fixtures
against the committed files before rebuilding, and against the fresh build. wasm/test.mjs takes ENGINE_DIR.
@deaneeth
deaneeth merged commit db7a949 into main Oct 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant