summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam Nystrom <sam@samnystrom.dev>2023-10-25 17:43:11 -0400
committerSam Nystrom <sam@samnystrom.dev>2023-10-25 17:43:11 -0400
commitb68ebb8e338114da3a21991e8423d00fbd83a0b9 (patch)
tree692fd6603797732c5599f015e942b4f2e0675206 /README.md
parent8249239acdf72c330818f2f8b8b320a84ac45d89 (diff)
Rewrite man page in mdoc0.3.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 5 insertions, 9 deletions
diff --git a/README.md b/README.md
index acfbaeb..48aa2f5 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,20 @@
# srtplay
-Play .srt subtitle files in a terminal.
+Play SRT subtitle files in a terminal.
## Installation
-1. Install [Perl](https://perl.org) and [scdoc](https://git.sr.ht/~sircmpwn/scdoc)
+1. Install [Perl](https://perl.org)
2. Install the Time::HiRes, Term::ReadKey, and XML::Parser Perl modules
-3. `make`
-4. `make install`
+3. `make install`
## Usage
```sh
-srtplay <file>.srt
+srtplay <file>
```
-See the [man page](https://git.sr.ht/~stonks3141/srtplay/tree/main/item/srtplay.1.scd)
-for further information.
-
-### TUI key bindings
+### Key bindings
- `q`, `<Ctrl-C>`: exit the program
- `k`, `<space>`: pause or resume playback