Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
palemieux committed Nov 25, 2023
1 parent ecec1fa commit d4dd4f5
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ tt convert -i <input .scc file> -o <output .ttml file>
* `"imsc_writer": JSON object`: IMSC Writer configuration options (see below)
* `"stl_reader": JSON object`: STL Reader configuration options (see below)
* `"vtt_writer": JSON object`: WebVTT Writer configuration options (see below)
* `"srt_writer": JSON object`: SRT Writer configuration options (see below)
* `"scc_reader": JSON object`: SCC Reader configuration options (see below)

Example:

Expand Down Expand Up @@ -207,6 +209,17 @@ Default: `false`

Default: `true`

### SCC Reader configuration

#### text_alignment

`"text_align" : "auto" | "left" | "center" | "right"`

Specifies the text alignment. `"auto"` means the reader will use heuristics to determine
text alignment.

Default: `"auto"`

### Library

The overall architecture of the library is as follows:
Expand Down Expand Up @@ -281,7 +294,7 @@ Automated testing is provided by the script at `scripts/ci.sh`

#### Local

Run `./scripts/ci.sh`
Run `PYTHONPATH=src/main/python ./scripts/ci.sh`

#### GitHub actions

Expand Down

0 comments on commit d4dd4f5

Please sign in to comment.