Skip to content

Commit 06b00b2

Browse files
committed
docs: fix broken SVG references and move images to docs/images/
SVGs were referenced by UUID filenames (generated by Showboat) that never existed in the repo. Replace with correct demo-*.svg paths, move all SVGs to docs/images/, and link demo.md from README.
1 parent 3e2f53a commit 06b00b2

9 files changed

Lines changed: 10 additions & 38 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Colorize terminal output using the [Dracula](https://draculatheme.com) color palette.
44

5-
A lolcat-compatible CLI tool with three coloring modes.
5+
A lolcat-compatible CLI tool with three coloring modes. See the [demo](demo.md) for visuals.
66

77
## Usage
88

demo.md

Lines changed: 9 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,7 @@ Each character advances through the Dracula palette. `-spread` controls how many
3333
printf "Painful zombies quickly watch a jinxed graveyard.\n..." | lolbat -spread 1.0
3434
```
3535

36-
```bash {image}
37-
\![Sequential mode: -spread 1.0](demo-sequential.svg)
38-
```
39-
40-
![Sequential mode: -spread 1.0](f2acbd18-2026-02-26.svg)
36+
![Sequential mode: -spread 1.0](docs/images/demo-sequential.svg)
4137

4238
## Sine mode
4339

@@ -47,11 +43,7 @@ The palette index oscillates along a sine wave. `-freq` controls wave frequency;
4743
printf "Painful zombies quickly watch a jinxed graveyard.\n..." | lolbat -mode sine -freq 0.5 -spread 2.0
4844
```
4945

50-
```bash {image}
51-
\![Sine mode: -mode sine -freq 0.5 -spread 2.0](demo-sine.svg)
52-
```
53-
54-
![Sine mode: -mode sine -freq 0.5 -spread 2.0](13b61472-2026-02-26.svg)
46+
![Sine mode: -mode sine -freq 0.5 -spread 2.0](docs/images/demo-sine.svg)
5547

5648
## Random mode
5749

@@ -61,11 +53,7 @@ Each line gets one color, chosen by a seeded PRNG keyed on `-seed + line number`
6153
printf "Painful zombies quickly watch a jinxed graveyard.\n..." | lolbat -mode random
6254
```
6355

64-
```bash {image}
65-
\![Random mode: -mode random](demo-random.svg)
66-
```
67-
68-
![Random mode: -mode random](79524458-2026-02-26.svg)
56+
![Random mode: -mode random](docs/images/demo-random.svg)
6957

7058
## Mode comparison
7159

@@ -77,11 +65,7 @@ printf "..." | lolbat -mode sine -spread 2.0
7765
printf "..." | lolbat -mode random
7866
```
7967

80-
```bash {image}
81-
\![Mode comparison: sequential / sine / random](demo-modes.svg)
82-
```
83-
84-
![Mode comparison: sequential / sine / random](9dcf0234-2026-02-26.svg)
68+
![Mode comparison: sequential / sine / random](docs/images/demo-modes.svg)
8569

8670
## Spread comparison
8771

@@ -93,11 +77,7 @@ printf "..." | lolbat -spread 3.0
9377
printf "..." | lolbat -spread 6.0
9478
```
9579

96-
```bash {image}
97-
\![Spread comparison: -spread 1 / 3 / 6](demo-spread.svg)
98-
```
99-
100-
![Spread comparison: -spread 1 / 3 / 6](5ebdd4c0-2026-02-26.svg)
80+
![Spread comparison: -spread 1 / 3 / 6](docs/images/demo-spread.svg)
10181

10282
## Seed variations
10383

@@ -110,11 +90,7 @@ printf "..." | lolbat -seed 7 -spread 2.0
11090
printf "..." | lolbat -seed 10 -spread 2.0
11191
```
11292

113-
```bash {image}
114-
\![Seed variations: -seed 0 / 3 / 7 / 10](demo-seed.svg)
115-
```
116-
117-
![Seed variations: -seed 0 / 3 / 7 / 10](6b00f5f5-2026-02-26.svg)
93+
![Seed variations: -seed 0 / 3 / 7 / 10](docs/images/demo-seed.svg)
11894

11995
## Freq comparison (sine mode)
12096

@@ -127,11 +103,7 @@ printf "..." | lolbat -mode sine -freq 0.6 -spread 2.0
127103
printf "..." | lolbat -mode sine -freq 1.0 -spread 2.0
128104
```
129105

130-
```bash {image}
131-
\![Freq comparison: -mode sine -freq 0.1 / 0.3 / 0.6 / 1.0](demo-freq.svg)
132-
```
133-
134-
![Freq comparison: -mode sine -freq 0.1 / 0.3 / 0.6 / 1.0](74c6d2dc-2026-02-26.svg)
106+
![Freq comparison: -mode sine -freq 0.1 / 0.3 / 0.6 / 1.0](docs/images/demo-freq.svg)
135107

136108
## Test suite
137109

@@ -155,10 +127,10 @@ go test ./... -v
155127
=== RUN TestANSI
156128
--- PASS: TestANSI (0.00s)
157129
PASS
158-
ok github.com/jamesfishwick/lolbat (cached)
130+
ok github.com/jamesfishwick/lolbat (cached)
159131
```
160132

161133
## Source
162134

163-
- GitHub: https://github.com/jamesfishwick/lolbat
135+
- GitHub: <https://github.com/jamesfishwick/lolbat>
164136
- Go 1.21+, stdlib only — no external dependencies.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)