merge with master

ISSUE_TEMPLATE.md

@@ -13,6 +13,9 @@ A clear and concise description of what you expected to happen.
 ###Screenshots and logs
 If applicable, add screenshots and/or logs to help explain your problem. You can obtain detailed logs by passing in the `--debug` or `-d` flag when running the `subaligner_1pass`, `subaligner_2pass` or `subaligner` CLI.
 
+###Media files
+Sharing your audiovisual files and subtitle files may help with debugging. Make sure they don't contain any private or sensitive data before sharing.
+
 ###Desktop (please complete the following information):
  - Operating System
  - Python Version

README.md

@@ -8,17 +8,17 @@
 ## Dependencies
 [FFmpeg](https://www.ffmpeg.org/) and [eSpeak](http://espeak.sourceforge.net/index.html)
 ```
-apt-get install ffmpeg espeak libespeak1 libespeak-dev espeak-data
+$ apt-get install ffmpeg espeak libespeak1 libespeak-dev espeak-data
 ```
 or
 ```
-brew install ffmpeg espeak
+$ brew install ffmpeg espeak
 ```
 ## Installation
 ```
 # Install from PyPI (pre-emptive NumPy)
-pip install numpy 
-pip install subaligner
+$ pip install numpy 
+$ pip install subaligner
 ```
 or
 ```
@@ -38,15 +38,15 @@ or
 ```
 # Install from source
 
-git clone [email protected]:baxtree/subaligner.git
-cd subaligner
-make install && source .venv/bin/activate
+$ git clone [email protected]:baxtree/subaligner.git
+$ cd subaligner
+$ make install && source .venv/bin/activate
 ```
 or
 ```
 # Use dockerised installation
 
-docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash
+$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash
 ```
 
 ## Usage

site/source/index.rst

@@ -7,8 +7,8 @@ Welcome to Subaligner's documentation!
 ======================================
 
 Given an out-of-sync subtitle file along with a piece of audiovisual content carrying speeches described by it,
-Subaligner provides a one-stop solution on automatic subtitle alignment based on Deep Neural Network and Forced
-Alignment. In essence, aligning subtitles is a two-stage process with a Bidirectional Long Short-Term Memory network trained
+Subaligner provides a one-stop solution on automatic subtitle synchronisation with a pretrained deep neural network and forced
+alignments. In essence, aligning subtitles is a two-stage process with a Bidirectional Long Short-Term Memory network trained
 upfront and Subaligner helps subtitlers not only in preprocessing raw subtitle materials (outcome from stenographers or
 STT workflow, etc.) but also in gaining quality control over their work within subtitle post-production. This solution
 also tolerates errors occurred in live subtitles which sometimes do not completely or correctly represent what people

site/source/usage.rst

@@ -54,4 +54,3 @@ Currently the stretching is experimental and only works for speech and subtitles
     (.venv) $ subaligner_2pass -v video.mp4 -s subtitle.srt -o /path/to/the/output/subtitle.srt
     or
     (.venv) $ subaligner -m dual -v video.mp4 -s subtitle.srt -o /path/to/the/output/subtitle.srt
-