From b68ebb8e338114da3a21991e8423d00fbd83a0b9 Mon Sep 17 00:00:00 2001 From: Sam Nystrom Date: Wed, 25 Oct 2023 17:43:11 -0400 Subject: Rewrite man page in mdoc --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'README.md') 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 .srt +srtplay ``` -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`, ``: exit the program - `k`, ``: pause or resume playback -- cgit v1.2.3