diff --git a/README.md b/README.md index 73be5af..3ddd91c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ -# HTML5_Video_Generator +# [HTML5_Video_Generator](https://gitea.dubtempo.com/DT/HTML5_Video_Generator) -This script uses FFMPEG to generate HTML5 video files and markup based on an input video. \ No newline at end of file +This script uses FFMPEG to generate HTML5 video files and markup based on an input video. + +
+ +## Requirements + +Make sure all dependencies have been installed before using this script: + +* [FFMPEG](https://www.passwordstore.org/) ~ tested on Ubuntu 18.04, version 3.4.8 + +
+ +## Project Installation + +Install this project via git pull: + +```shell +# from your new project parent dir +$ git clone https://gitea.dubtempo.com/DT/HTML5_Video_Generator.git +``` + +Make sure the script file is executable. + +```shell +# from your new project parent dir +$ chmod u+x html5vid.sh +``` + +
+ +## Project Usage + +To use this script, complete the following steps. + +1. Update the name of the output directory if you'd like (you may want to update the gitignore as well). + +1. Run the script by passing a single file, or collection of files. + +### Single File + +Pass a sinlge file as a standard input + +```shell +$ html5vid.sh somefile.mov +``` + +### Multiple File + +Pass multiple files as standard inputs + +```shell +$ html5vid.sh somefile.mov somefile2.mov +``` + +### Loop Of Files + +You can also loop / use globs. Be sure your environment supports globs. + +```shell +$ for file in '/somedir/*'; do ./html5vid.sh $file; done +``` \ No newline at end of file