summaryrefslogtreecommitdiff
path: root/README.md
blob: 0d126e74e9094a4d4fc1f99f26a8b0f6b32bda04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# srtplay

Play .srt subtitle files in a TUI.

## Installation

Install [hare](https://harelang.org), [scdoc](https://git.sr.ht/~sircmpwn/scdoc),
and optionally [haredo](https://sr.ht/~autumnull/haredo).

### With haredo

```sh
curl 'https://git.sr.ht/~stonks3141/srtplay/archive/0.1.0.tar.gz' | tar -xz
cd srtplay-0.1.0
PREFIX=/usr/local haredo install
```

### Without haredo

```sh
curl 'https://git.sr.ht/~stonks3141/srtplay/archive/0.1.0.tar.gz' | tar -xz
cd srtplay-0.1.0

hare build .
scdoc < srtplay.1.scd > srtplay.1

mkdir -p /usr/local/bin
cp ./srtplay /usr/local/bin
mkdir -p /usr/local/share/man/man1
cp ./srtplay.1 /usr/local/share/man/man1
```

## Usage

```sh
srtplay <file>.srt
```

See the [man page](https://git.sr.ht/~stonks3141/srtplay/tree/main/item/srtplay.1.scd)
for further information.

### TUI key bindings

- `q`: exit the program
- `j`: fast-backward by 10 seconds
- `k`: pause or resume playback
- `l`: fast-forward by 10 seconds

## Contributing

[Send patches](https://git-send-email.io) and bug reports to
[~stonks3141/public-inbox@lists.sr.ht](mailto:~stonks3141/public-inbox@lists.sr.ht)
([archive](https://lists.sr.ht/~stonks3141/public-inbox)).