Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,31 +64,29 @@ always use `UPDATE_GOLDEN=1` to regenerate them from a passing smoosh run.

## Updating the Demos

The demos are recorded with [VHS](https://github.com/charmbracelet/vhs)
(`brew install vhs`). There are three tape files:
The demos live in `assets/`. The interactive demo has a
[VHS](https://github.com/charmbracelet/vhs) tape file (`brew install vhs`):

| Tape | Output | Shows |
| --- | --- | --- |
| `demo-logo.tape` | `demo-logo.gif` | Banner logo (README hero) |
| `demo.tape` | `demo.gif` | Interactive mode flow |
| `demo-power.tape` | `demo-power.gif` | Power-user flags |
| `assets/demo.tape` | `assets/demo.gif` | Interactive mode flow |

Re-record after the relevant change:
The other GIFs (`demo-logo.gif`, `demo-power.gif`) are recorded manually.

| When to re-record | Tapes affected |
Re-record when relevant:

| When to re-record | Files affected |
| --- | --- |
| Visual style changes (colours, banner, symbols) | `demo-logo.tape`, `demo.tape` |
| Interactive mode UI changes | `demo.tape` |
| New major flags or output format changes | `demo-power.tape` |
| Visual style changes (colours, banner, symbols) | `assets/demo-logo.gif`, `assets/demo.gif` |
| Interactive mode UI changes | `assets/demo.gif` |
| New major flags or output format changes | `assets/demo-power.gif` |

```bash
vhs demo-logo.tape # logo — re-record when visual style changes
vhs demo.tape # interactive flow — re-record when UI changes
vhs demo-power.tape # power-user flags — re-record when flags change
vhs assets/demo.tape # interactive flow — re-record when UI changes
```

Commit the updated `.gif` files alongside the code change that prompted the
re-record. The tapes are the source of truth — never edit the GIFs by hand.
re-record.

## Code Style

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

![smoosh logo](demo-logo.gif)
![smoosh logo](assets/demo-logo.gif)

[![CI](https://github.com/K1-R1/smoosh/actions/workflows/ci.yml/badge.svg)](https://github.com/K1-R1/smoosh/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
Expand All @@ -12,7 +12,7 @@
Turn any git repo into AI-ready context — for NotebookLM, Claude Projects,
ChatGPT, or your own RAG pipeline. Pure bash, zero dependencies.

![smoosh interactive demo](demo.gif)
![smoosh interactive demo](assets/demo.gif)

</div>

Expand Down Expand Up @@ -90,7 +90,7 @@ telemetry. Private repos need this. Public ones benefit too.

Preview, filter, and pipe — all from flags:

![smoosh power user demo](demo-power.gif)
![smoosh power user demo](assets/demo-power.gif)

## Installation

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions demo.tape → assets/demo.tape
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# smoosh demo — interactive mode (hero)
# Record with: vhs demo.tape
# Record with: vhs assets/demo.tape
# Requires: brew install vhs

Output demo.gif
Output assets/demo.gif

Require bash

Expand Down