summaryrefslogtreecommitdiff
path: root/ext/kate/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/kate/README')
-rw-r--r--ext/kate/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/ext/kate/README b/ext/kate/README
new file mode 100644
index 000000000..394b057ae
--- /dev/null
+++ b/ext/kate/README
@@ -0,0 +1,20 @@
+Kate is a free codec for text based data, which can also carry images.
+It is typically used to create overlays on a video.
+
+libkate, a codec for Kate streams, is required to build this plugin:
+http://libkate.googlecode.com/
+
+libtiger, a rendering library for Kate streams, is optional:
+http://libtiger.googlecode.com/
+
+The Kate plugin contains various elements to manipulate Kate streams:
+
+ - katedec: decodes Kate streams to text
+ - kateenc: encodes Kate streams from text and SPU images
+ - kateparse: parses Kate streams
+ - katetag: allows changing metadata in Kate streams
+ - tiger: decodes and renders Kate streams using libtiger (needs libtiger)
+
+More information about Kate can be found at:
+http://wiki.xiph.org/index.php/OggKate
+