From d78a2530da91b76625b71c2aeaf3293abc6c3a4b Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Wed, 6 May 2026 09:42:43 +0300 Subject: move demo/ to docs/tutorial/, commit assets, consolidate TUI docs - demo/ renamed to docs/tutorial/ (tapes, scripts, TUTORIAL.md) - docs/tutorial/assets/ added to git (51 MB of GIFs + PNGs); removed /demo/assets/ from .gitignore so images render on Codeberg - docs/tui-reference.md removed; its hotkey tables merged into a new "Hotkey Quick Reference" section at the end of TUTORIAL.md - TUTORIAL.md: updated install section (mage buildDocker, no GOTOOLCHAIN=auto), fixed README relative path (../../README.md), updated internal tapes/scripts/assets path prose - README.md: updated all demo/ image paths and links to docs/tutorial/; TUI and recording-modes links now point to TUTORIAL.md anchors - AGENTS.md: updated demo/ references to docs/tutorial/ - Magefile.go: updated demoDir/demoTapesDir/demoScriptsDir/demoRunTape/ demoSudoKeepers constants to docs/tutorial/ paths Co-Authored-By: Claude Sonnet 4.6 --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f031fc6..739e681 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -> **🚧 PRE-ALPHA SOFTWARE:** This project is in a pre-alpha state and is intended for my own personal use only. Use at your own risk. - # I/O Riot NG (aka ior) @@ -14,13 +12,13 @@ This works only on Linux! ## Demo -A short guided tour with animated GIFs of every major surface lives in [`demo/TUTORIAL.md`](./demo/TUTORIAL.md). Two teasers: +A short guided tour with animated GIFs of every major surface lives in [`docs/tutorial/TUTORIAL.md`](./docs/tutorial/TUTORIAL.md). Two teasers: -Cold start: PID picker, then the dashboard appears +Cold start: PID picker, then the dashboard appears -Live in-TUI flamegraph rebuilding from real workload +Live in-TUI flamegraph rebuilding from real workload -The demo is fully reproducible: `mage installDemoTools` once, then `sudo -v && mage demo` regenerates every GIF and screenshot. See the [tutorial](./demo/TUTORIAL.md) for the full walkthrough. +The demo is fully reproducible: `mage installDemoTools` once, then `sudo -v && mage demo` regenerates every GIF and screenshot. See the [tutorial](./docs/tutorial/TUTORIAL.md) for the full walkthrough. ## Requirements @@ -80,7 +78,7 @@ explanation. Press **H** inside the dashboard to toggle the built-in help panel. Tabs are reachable with **tab/shift+tab** or number keys **1–6**. Full hotkey reference: -[docs/tui-reference.md](./docs/tui-reference.md). +[docs/tutorial/TUTORIAL.md](./docs/tutorial/TUTORIAL.md#hotkey-quick-reference). ## Recording Modes @@ -94,4 +92,4 @@ reachable with **tab/shift+tab** or number keys **1–6**. Full hotkey reference | Parquet recording | press `R` in TUI, or `-parquet ` | streaming Parquet file | Full details and the `.ior.zst` vs Parquet trade-off: -[docs/tui-reference.md](./docs/tui-reference.md). +[docs/tutorial/TUTORIAL.md](./docs/tutorial/TUTORIAL.md#recording-for-offline-analysis). -- cgit v1.2.3