diff options
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..82e6c0a --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# 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 +git clone https://git.sr.ht/~stonks3141/srtplay +cd srtplay +PREFIX=/usr/local haredo install +``` + +### Without haredo + +```sh +git clone https://git.sr.ht/~stonks3141/srtplay +cd srtplay + +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 +``` + +### 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)). |