Add README with demo GIF

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
rolandnsharp
2026-04-05 12:47:30 +10:00
parent 448b303eba
commit 7ceac6c91f
3 changed files with 47 additions and 1 deletions

1
.gitignore vendored
View File

@@ -1,4 +1,3 @@
crt
nimcache/
demo.gif
demo.png/

47
README.md Normal file
View File

@@ -0,0 +1,47 @@
# terminal-oscilloscope
A terminal-based oscilloscope with CRT phosphor physics, written in Nim using [illwill](https://github.com/johnnovak/illwill).
![demo](demo.gif)
## Features
- **CRT boot/shutdown animations** — phosphor ramp, beam sweep, vertical collapse, dot fade
- **Y-T and X-Y modes** — time-domain waveform or Lissajous figures
- **Phosphor persistence** — beam bloom, decay trails, intensity-based shading
- **Half-block rendering** — 2x vertical resolution using Unicode `▀▄█` characters
- **Live audio capture** — visualises system audio via ffmpeg/PulseAudio monitor
- **Demo mode** — built-in synthesised waveforms when no audio source is available
## Install
Requires [Nim](https://nim-lang.org/) 2.x.
```bash
git clone https://github.com/rolandnsharp/terminal-oscilloscope.git
cd terminal-oscilloscope
nimble build
./crt
```
## Controls
| Key | Action |
|-----|--------|
| `m` | Toggle Y-T / X-Y mode |
| `+` / `-` | Increase / decrease gain (amplitude) |
| `]` / `[` | Zoom in / out time axis |
| `g` | Cycle grid: full → crosshair → off |
| `space` | Freeze display |
| `d` | Cycle demo frequency presets |
| `q` | Quit (with CRT shutdown effect) |
## Audio
Captures system audio automatically using `ffmpeg` with the PulseAudio/PipeWire monitor of your default output sink. Falls back to `parec` if available, or a built-in demo signal.
No extra packages needed — just `ffmpeg` (pre-installed on most Linux systems).
## Credits
CRT turn-on/off animations inspired by [AetherTune](https://github.com/nevermore23274/AetherTune).

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 MiB