Skip to content

Commit ffed927

Browse files
committed
Update instructions for how to run Docker image with audio
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent 706c8ce commit ffed927

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
[![Docker Image](https://img.shields.io/badge/docker-ghcr.io-blue.svg)](https://ghcr.io/kernelkit/demo)
66
[![Latest Release](https://img.shields.io/github/v/release/kernelkit/demo?include_prereleases&label=latest)](https://github.com/kernelkit/demo/releases/latest)
77

8-
A classic demoscene-style demo featuring multiple visual effects with oldschool aesthetics. Built with SDL2 and inspired by 1990s Amiga/PC demos.
8+
A classic demoscene-style demo featuring multiple visual effects with
9+
oldschool aesthetics. Built with SDL2 and inspired by 1990s Amiga/PC
10+
demos.
911

1012
![Demo Screenshot](demo-screenshot.png)
1113

@@ -28,6 +30,7 @@ The demo includes 9 different scenes that cycle automatically:
2830
### Text Scrollers
2931

3032
Multiple scroller styles with smooth effects:
33+
3134
- **Classic** — Traditional bottom scroller
3235
- **Sine Wave** — Undulating wave motion
3336
- **3D Roller** — Perspective roller with configurable outline/glow effects
@@ -48,13 +51,15 @@ Multiple scroller styles with smooth effects:
4851
Download the latest AppImage for your architecture:
4952

5053
**x86_64 (Intel/AMD):**
54+
5155
```bash
5256
wget https://github.com/kernelkit/demo/releases/latest/download/InfixDemo-x86_64.AppImage
5357
chmod +x InfixDemo-x86_64.AppImage
5458
./InfixDemo-x86_64.AppImage
5559
```
5660

5761
**aarch64 (ARM64):**
62+
5863
```bash
5964
wget https://github.com/kernelkit/demo/releases/latest/download/InfixDemo-aarch64.AppImage
6065
chmod +x InfixDemo-aarch64.AppImage
@@ -66,18 +71,33 @@ No installation required! The AppImage bundles all dependencies.
6671
### Run with Docker
6772

6873
**Pull and run the latest image:**
74+
6975
```bash
7076
# Allow X11 connections (run once per session)
7177
xhost +local:docker
7278

73-
# Run the demo
79+
# Run the demo (video only)
80+
docker run --rm -it \
81+
-e DISPLAY=$DISPLAY \
82+
-v /tmp/.X11-unix:/tmp/.X11-unix \
83+
ghcr.io/kernelkit/demo:latest
84+
```
85+
86+
**With audio support (PulseAudio/PipeWire):**
87+
88+
```bash
89+
xhost +local:docker
7490
docker run --rm -it \
7591
-e DISPLAY=$DISPLAY \
7692
-v /tmp/.X11-unix:/tmp/.X11-unix \
93+
-e SDL_AUDIODRIVER=pulseaudio \
94+
-e PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native \
95+
-v ${XDG_RUNTIME_DIR}/pulse/native:${XDG_RUNTIME_DIR}/pulse/native \
7796
ghcr.io/kernelkit/demo:latest
7897
```
7998

8099
**Or use docker-compose:**
100+
81101
```bash
82102
docker compose up
83103
```

0 commit comments

Comments
 (0)