summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc71bbf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+srt2vtt
+=======
+
+Convert SRT formatted subtitles to WebVTT format for use with the
+HTML5 `<track>` tag.
+
+Usage
+-----
+
+```
+$ srt2vtt --help
+Usage: srt2vtt [OPTIONS]
+Convert SubRip formatted subtitles to WebVTT format.
+
+ -h, --help display this help and exit
+ -v, --version display version and exit
+ -i, --input=FILE-NAME read input from FILE-NAME
+ -o, --output=FILE-NAME write output to FILE-NAME
+```
+
+If `--input` or `--output` is ommitted, read from stdin or stdout,
+respectively.
+
+Installation
+------------
+
+```
+autoreconf -vif
+./configure
+make install
+```
+
+Alternatively, just copy `srt2vtt` yourself to wherever you would like
+it. Or, call it from your own git checkout.
+
+Requirements
+------------
+
+* GNU Guile >= 2.0.5
+
+License
+-------
+
+GNU GPLv3+