Add test suite.
[srt2vtt.git] / README.md
1 srt2vtt
2 =======
3
4 Convert SRT formatted subtitles to WebVTT format for use with the
5 HTML5 `<track>` tag.
6
7 Usage
8 -----
9
10 ```
11 $ srt2vtt --help
12 Usage: srt2vtt [OPTIONS]
13 Convert SubRip formatted subtitles to WebVTT format.
14
15   -h, --help             display this help and exit
16   -v, --version          display version and exit
17   -i, --input=FILE-NAME  read input from FILE-NAME
18   -o, --output=FILE-NAME write output to FILE-NAME
19 ```
20
21 If `--input` or `--output` is ommitted, read from stdin or stdout,
22 respectively.
23
24 Installation
25 ------------
26
27 ```
28 ./bootstrap
29 ./configure
30 make
31 make install
32 ```
33
34 Alternatively, just copy `srt2vtt` yourself to wherever you would like
35 it.  Or, call it from your own git checkout.
36
37 Requirements
38 ------------
39
40 * GNU Guile >= 2.0.5
41
42 License
43 -------
44
45 GNU GPLv3+