Skip to content
Snippets Groups Projects
Commit 866db8b8 authored by William Bell's avatar William Bell
Browse files

Update README.md

parent 7ffb4b25
No related branches found
No related tags found
No related merge requests found
......@@ -2,4 +2,16 @@
A project to generate PDF files from input caption files.
webvtt-py
\ No newline at end of file
# Dependencies
The project uses pdflatex, Python 3 and the `webvtt-py` Python 3 module. To install the `webvtt-py` module `pip` or `pip3` should be used, repending on the Python 3 installation.
# Usage
1. Put the `.srt` and `.vtt` files to be converted into a directory.
2. Start from the example `data/captions.csv` file and add rows for each `.srt` or `.vtt` file.
3. Save the updated `captions.csv` file in the same directory as the `.srt` and `.vtt` files.
4. Use python3 to run the file `python/transcripts.py`.
5. Use the file dialogue window and select the updated `captions.csv` file.
The program will then convert each `.srt` or `.vtt` file to a PDF file. The pdflatex command takes a few seconds to run. Therefore, it may take a few minutes to process several caption files.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment