Skip to content

Commit

Permalink
updated userguide notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
georgiewellock committed Jul 8, 2019
1 parent 57361c5 commit 4b6cc47
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@ it is crackling. It will still be recording the audio.

## Simple useage

Example usage can be found in this [jupyter notebook](https://github.com/georgiewellock/VTT_formatter/blob/master/VTT_formatter.ipynb).

The screenshot belows shows the simple implementation of the VTT formatter in a jupyter notebook. This will read in the file defined and create a new `.txt` file in the same directory as the original.
<img src="https://github.com/georgiewellock/VTT_formatter/blob/master//figures/example_usage.png"/>

Further information can be found in the notebook [here](https://github.com/georgiewellock/VTT_formatter/blob/master/VTT_formatter.ipynb)

## Installation

The simplest way to install this vttformatter is to use `pip` to install from [PyPI](https://pypi.org/project/vttformatter/)
Expand Down

0 comments on commit 4b6cc47

Please sign in to comment.