added description for automatic setup script

This commit is contained in:
K4YT3X 2018-11-29 15:12:22 -05:00
parent 369b6904b2
commit 31736f557a

View File

@ -2,14 +2,14 @@
### This software is currently designed for Windows.
## Setup Script (November 29, 2018)
- Added setup script. Now you can install dependencies and generate video2x configuraiton automatically by running the `video2x_setup.py` script.
## 2.1.6 (November 26, 2018)
- Restored the option to define a factor which the will be upscaled by, which is suggested by @wuast94 .
## 2.1.4 (November 2, 2018)
- Added hardware acceleration option for ffmpeg. Ffmpeg will use hardware acceleration (GPU, usually) if `--gpu` or `--cudnn` is given. You can customize the method to use in `video2x.json`.
## Description
Video2X is an automation software based on waifu2x image enlarging engine. It extracts frames from a video, enlarge it by a number of times without losing any details or quality, keeping lines smooth and edges sharp.
@ -38,6 +38,15 @@ Download: https://ffmpeg.org/download.html
- **waifu2x-caffe for Windows**
Download: https://github.com/lltcggie/waifu2x-caffe/releases
### Install Dependencies
You can run the `video2x_setup.py` script to install and configure the depencies automatically. This script is designed and tested on Windows 10.
This script will install `ffmpeg`, `waifu2x-caffe` to `%LOCALAPPDATA%\\video2x` and all python libraries.
```bash
$ python video2x_setup.py
```
After downloading the dependencies, clone the video2x package.
@ -51,7 +60,6 @@ Then you'll need to install python dependencies before start using video2x. Inst
$ pip install -r requirements.txt
```
## Quick Start
To enlarge a video on a computer with NVIDIA GPU