diff --git a/README.md b/README.md index 8ffc1c9..13fdc83 100644 --- a/README.md +++ b/README.md @@ -158,8 +158,11 @@ and paste [the prompt](examples/demo/PROMPT.md): it fixes the bug, adds an animated color renderer + starting patterns, and runs its own self-test, ending on a glider crawling across the screen. - - +

+ A colored Conway's Game of Life glider crawling across the terminal — the demo's end state +

+ +

The demo's payoff: an animated, colored glider crawling across the terminal. Record your own run over this — see assets/demo/README.md.

Verified live against real backends: **GPT‑5.5** (Codex login) and **Cursor Composer**, plus an offline self-test that runs in CI on Linux/Windows × diff --git a/assets/brand/README.md b/assets/brand/README.md index 56440c0..e08ffc2 100644 --- a/assets/brand/README.md +++ b/assets/brand/README.md @@ -10,6 +10,12 @@ display on HiDPI screens. | `architecture.png` | "How it works" flow diagram | 1280×600 | | `quickstart.png` | Three-step quick start strip | 1280×330 | | `auto-router.png` | Auto Router "how it routes" diagram | 1280×650 | +| `doc-setup.png` | `docs/SETUP.md` header | 1280×210 | +| `doc-how.png` | `docs/HOW_IT_WORKS.md` header | 1280×210 | +| `doc-add.png` | `docs/ADD_A_MODEL.md` header | 1280×210 | +| `doc-trouble.png` | `docs/TROUBLESHOOTING.md` header | 1280×210 | + +The animated demo lives at [`../demo/demo.gif`](../demo/demo.gif). Palette: indigo `#6366f1` → violet `#8b5cf6` → purple `#a855f7` → fuchsia `#c026d3` on a near-black `#0a0c14` background, matching the `ultracode` app icon. diff --git a/assets/brand/doc-add.png b/assets/brand/doc-add.png new file mode 100644 index 0000000..25d69a0 Binary files /dev/null and b/assets/brand/doc-add.png differ diff --git a/assets/brand/doc-how.png b/assets/brand/doc-how.png new file mode 100644 index 0000000..770eed7 Binary files /dev/null and b/assets/brand/doc-how.png differ diff --git a/assets/brand/doc-setup.png b/assets/brand/doc-setup.png new file mode 100644 index 0000000..f94e325 Binary files /dev/null and b/assets/brand/doc-setup.png differ diff --git a/assets/brand/doc-trouble.png b/assets/brand/doc-trouble.png new file mode 100644 index 0000000..1c30ca2 Binary files /dev/null and b/assets/brand/doc-trouble.png differ diff --git a/assets/demo/README.md b/assets/demo/README.md index 5b9a8b1..4a645ba 100644 --- a/assets/demo/README.md +++ b/assets/demo/README.md @@ -1,10 +1,12 @@ # Demo media + recording guide -Drop your screen recording here and the README will show it off. +`demo.gif` here is an **illustrative placeholder** — a rendered, colored Game of +Life glider crawling across a terminal (the demo's end state). It is *not* a +capture of a live agent session. Replace it with your own screen recording to +show the real workflow; the root `README.md` already points at this path. -- **For GitHub:** save a looping `demo.gif` in this folder, then uncomment the - image line in the root `README.md` (under **## Demo**): - `![UltraCode-Shim demo](assets/demo/demo.gif)` +- **For GitHub:** save a looping `demo.gif` in this folder (overwrite the + placeholder). The root `README.md` renders it under **## Demo**. - **For X/Twitter:** post the `.mp4` directly (X autoplays video; no GIF needed). ## Shot list (≈45–60s, for the X video) diff --git a/assets/demo/demo.gif b/assets/demo/demo.gif new file mode 100644 index 0000000..f5fb3de Binary files /dev/null and b/assets/demo/demo.gif differ diff --git a/docs/ADD_A_MODEL.md b/docs/ADD_A_MODEL.md index 70fe2e8..2944562 100644 --- a/docs/ADD_A_MODEL.md +++ b/docs/ADD_A_MODEL.md @@ -1,4 +1,6 @@ -# Add a model +

+ Add a model — put any backend in the /model menu with templates per route type +

Everything lives in one file: **`config.json`** (copied from `config.example.json` on first run). To add a backend you edit two sections: diff --git a/docs/HOW_IT_WORKS.md b/docs/HOW_IT_WORKS.md index 0392ab8..8dad121 100644 --- a/docs/HOW_IT_WORKS.md +++ b/docs/HOW_IT_WORKS.md @@ -1,4 +1,6 @@ -# How it works +

+ How it works — the loopback proxy, the UltraCode envelope, and the evidence +

UltraCode-Shim is a tiny loopback proxy plus a launcher. There is no magic and no secret model. This page explains the mechanism and the reverse-engineering it diff --git a/docs/SETUP.md b/docs/SETUP.md index c999c3a..bcfcd32 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -1,4 +1,6 @@ -# Setup +

+ Setup — get running on Windows 11 or macOS / Linux / WSL +

Works on **Windows 11** (no WSL required) and on **macOS / Linux / WSL**. diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 3654d3f..0c646fd 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -1,4 +1,6 @@ -# Troubleshooting +

+ Troubleshooting — symptom to cause to fix, starting with the doctor +

First, always run the doctor — it catches most problems and prints the fix: