Skip to content

Commit 4c0d025

Browse files
committed
Update README
1 parent c438ff6 commit 4c0d025

File tree

1 file changed

+4
-17
lines changed

1 file changed

+4
-17
lines changed

README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ accurate, but also language-agnostic. This means
1313
you can align subtitles to movies in different
1414
languages.
1515

16-
`alass` stands for "Automatic Language-Agnostic Subtitle Synchronization".
16+
`alass` stands for "Automatic Language-Agnostic Subtitle Synchronization". The theory and algorithms
17+
are documented in my [bachelor's thesis](documentation/thesis.pdf)
18+
and summarized in my [bachelor's presentation](documentation/slides.pdf).
19+
1720

1821
## Executable for Windows (64-bit)
1922

@@ -107,22 +110,6 @@ $ cargo run -- movie.mp4 input.srt output.srt
107110

108111
All parameters are shown for `cargo build` can also be used for `cargo install` and `cargo run`.
109112

110-
#### Statistics
111-
112-
You can activate the statistics module inside `alass` using:
113-
114-
```bash
115-
# Important: you have to be inside `alass-cli`! Otherwise the parameter is ignored.
116-
$ cargo build --features statistics
117-
$ cargo run -- --statistics-path ./some/folder
118-
```
119-
120-
This will create the statistics file in `./some/folder`. You can use `--statistics-required-tag` to only generate statistics.
121-
122-
The statistics module allows you to understand/debug the algorithm better.
123-
124-
**Warning**: Using this configuration slows down the algorithm by 50% or more _even_ if no statistics files are generated.
125-
126113
#### FFmpeg as a library
127114

128115
You can also link `ffmpeg` as a dynamic library during compile time. The library implementation can extract the audio about 2 to 3 seconds faster. Unfortunately it is harder to compile, the error handling is only very basic and might still have bugs.

0 commit comments

Comments
 (0)