Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
clebeaupin committed Nov 3, 2022
1 parent 474c21f commit 10bd07b
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Usage:
...
VttParser parser = new VttParser("utf-8");
VttObject subtitle = parser.parse(new FileInputStream("/tmp/read/test.vtt"));

Writer
======

Expand All @@ -62,7 +62,7 @@ Usage:
...
SrtParser parser = new SrtParser("utf-8");
SrtObject subtitle = parser.parse(new FileInputStream("/tmp/read/test.srt"));

Writer
======

Expand All @@ -74,7 +74,7 @@ Usage:
...
SrtWriter writer = new SrtWriter("utf-8");
writer.write(subtitle, new FileOutputStream("/tmp/write/test.srt"));

SAMI
----

Expand All @@ -87,7 +87,7 @@ Usage:
...
SamiParser parser = new SamiParser("utf-8");
SamiObject subtitle = parser.parse(new FileInputStream("/tmp/read/test.smi"));

Writer
======

Expand All @@ -99,15 +99,15 @@ Usage:
...
SamiWriter writer = new SamiWriter("utf-8");
writer.write(subtitle, new FileOutputStream("/tmp/write/test.smi"));

STL
---

The implemented STL format is the binary version of STL EBU.
Currently only the reader is provided.

All the specifications described in this document
https://tech.ebu.ch/docs/tech/tech3264.pdf
All the specifications described in this document
https://tech.ebu.ch/docs/tech/tech3264.pdf
have been implemented, so you can get data from GSI and TTI blocks.

Advanced features
Expand All @@ -125,7 +125,7 @@ Usage:
...
StlParser parser = new StlParser();
StlObject subtitle = parser.parse(new FileInputStream("/tmp/read/test.stl"));

TTML
----

Expand All @@ -150,6 +150,14 @@ Usage:
TtmlWriter writer = new TtmlWriter();
writer.write(subtitle, new FileOutputStream("/tmp/write/test.ttml"));

Launch tests
------------

To launch tests:

mvn test


Jar package
-----------

Expand All @@ -165,4 +173,4 @@ Convert from command line

Usage:

java -jar subtitle-*.jar -i input-file -o output-file
java -jar subtitle-*.jar -i input-file -o output-file

0 comments on commit 10bd07b

Please sign in to comment.