Skip to main content

README: add a brief "how it works" explanation

ID
a41033e
date
2026-10-01 06:24:19+00:00
author
Alex Chan <alex@alexwlchan.net>
parent
acc46f8
message
README: add a brief "how it works" explanation
changed files
1 file, 10 additions

Changed files

README.md (1412 → 1801)

diff --git a/README.md b/README.md
index 71f997d..49816e6 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,16 @@ glancecast is a script that converts a video file into an MP3 with chapters that
 
 This allows you to listen to a video in an audio-only podcast player, but glance at the screen if you need some visual context.
 
+## How it works
+
+There are three steps:
+
+1.  Convert a video file to an MP3 (using FFMpeg)
+2.  Extract still frames from the video, every few seconds (also using FFMpeg)
+3.  Create [ID3 chapters](https://id3.org/id3v2-chapters-1.0) in the video, with the images as per-chapter cover art
+
+For more details, see [my article introducing glancecast](https://alexwlchan.net/2026/glancecast/).
+
 ## Installation
 
 Clone the Git repository, create a Python virtualenv, and install dependencies: