Create README.md

README.md

@@ -38,58 +38,62 @@ interpolation algorithm: default
 ```
 
 ## Requirements
+- [Python](https://www.python.org/downloads)
 - [FFmpeg](https://ffmpeg.org/download.html)
-- [VapourSynth x64](https://www.vapoursynth.com/)
+- [VapourSynth x64](https://www.vapoursynth.com)
 
 ### VapourSynth plugins
-- [FFmpegSource](https://github.com/FFMS/ffms2/releases/latest)
-- [InterFrame (ignore the dependencies)](https://www.spirton.com/interframe-2-8-2-released/)
+- [FFMS2](https://github.com/FFMS/ffms2)
+- [HAvsFunc](https://github.com/HomeOfVapourSynthEvolution/havsfunc)
 - [SVPflow 4.2.0.142](https://web.archive.org/web/20190322064557/http://www.svp-team.com/files/gpl/svpflow-4.2.0.142.zip)
-- [ClipBlend](http://avisynth.nl/index.php/ClipBlend)
 
 ## Installation
 Automatic:
-- Download and run [installer.bat](https://github.com/f0e/blur/blob/master/installer.bat) (Thanks Couleur)
+- Download and run [Installer.bat](https://raw.githubusercontent.com/f0e/blur/master/Installer.bat) to automatically install all of the requirements.
 
 Manual:
 1. Download [the latest release](https://github.com/f0e/blur/releases/latest) or build the project.
+3. Install Python
 2. Install FFmpeg and [add it to PATH](https://www.wikihow.com/Install-FFmpeg-on-Windows)
-3. Install the 64-bit version of VapourSynth
-4. vsrepo install havsfunc
+4. Install the 64-bit version of VapourSynth
+5. Install the required VapourSynth plugins using the command "vsrepo.py install ffms2 havsfunc"
+6. Install SVPflow 4.2.0.142 manually by moving the files inside "lib-windows/vapoursynth/x64" to "VapourSynth/plugins64"
 
 ## Usage
 1. Open the executable and drag a video file onto the console window, or directly drop video files onto the executable file.
 2. A config file will be generated in the video's directory, which can be modified to suit your needs.
 3. The program will process the inputted video according to the configuration file located in the same folder as the video, and will output the blurred version to the same directory with " - blur" appended.
 
+The program can also be used in the command line, use -h or --help for more information.
+
 ***
 
 ## Config settings explained:
-- cpu cores - amount of cpu cores you have
-
-- input fps - input video file fps
-- output fps - final output video file fps
-
 - input timescale - timescale of the input video file (will be sped up/slowed down accordingly)
 - output timescale - timescale of the output video file
 
 - blur - whether or not the output video file will have motion blur
 - blur amount - if blur is enabled, this is the amount of motion blur from 0-1
+- blur output fps - if blur is enabled, this is the fps the output video will be
 
 - interpolate - whether or not the input video file will be interpolated to a higher fps
 - interpolated fps - if interpolate is enabled, this is the fps that the input file will be interpolated to (before blending)
 
-- crf - [crf](https://trac.ffmpeg.org/wiki/Encode/H.264#crf) of the output video
-- gpu - experimental gpu acceleration (doesn't work)
+- preview - opens a render preview window
 - detailed filenames - adds blur settings to generated filenames
 
+- quality - [crf](https://trac.ffmpeg.org/wiki/Encode/H.264#crf) of the output video (qp if using GPU rendering)
+- multithreading - enables multithreaded rendering
+
+- gpu - enables experimental gpu accelerated rendering (likely slower)
+
 - interpolation speed - default is 'medium', [explained further here](https://www.spirton.com/uploads/InterFrame/InterFrame2.html)
 - interpolation tuning - default is 'smooth', [explained further here](https://www.spirton.com/uploads/InterFrame/InterFrame2.html)
 - interpolation algorithm - default is 13, [explained further here](https://www.spirton.com/uploads/InterFrame/InterFrame2.html)
 
 ## Recommended settings for gameplay footage:
 ### Config options
-- blur amount - for maximum blur/smoothness use 1, for medium blur use 0.5. 0.6-0.8 gives nice results
+- blur amount - for maximum blur/smoothness use 1, for medium blur use 0.5, low blur 0.2-0.3. 0.6-0.8 gives nice results for 60fps, 0.3~ is good for 30fps
 
 - interpolated fps - results become worse if this is too high, for 60fps source footage around 300-900 should be good, for 180fps 1200 is good