OSDN Git Service

Installer tweak.
[x264-launcher/x264-launcher.git] / README.md
index ea6b163..f1e5fd6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -25,19 +25,20 @@ Some key features of the Simple x264/x265 Launcher software include:
 
 # System Requirements #
 
+
+Simple x264 Launcher is *100% standalone*, i.e. it does **not** require Mircrosoft.NET, Java Runtime Environment or other "external" dependencies.
+
+The required Qt DLLs as well as the encoder binaries are *included* with the application. Frameservers, like *Avisynth* or *VapourSynth*, may need to be installed separately though.
+
 The minimum system requirements to run Simple x264/x265 Launcher are as follows:
 
-* Windows XP with Service Pack 2 or any later Windows system
-* 64-Bit Windows is highly recommended (32-Bit Windows works as well)
+* Windows XP with Service Pack 2 or any later Windows system – note that Windows XP is **not** recommended!
+* 64-Bit editions of Windows are highly recommended, though 32-Bit editions will work as well
 * The CPU must support at least the MMX and SSE instruction sets
-* Avisynth input only available with Avisynth 2.5+ installed
-* VapourSynth input only available with VapourSynth R19+ installed
+* Avisynth input only available with [Avisynth](http://avisynth.nl/index.php/Main_Page#Official_builds) **2.6** installed – Avisynth **2.5.x** is *not* recommended!
+* VapourSynth input only available with [VapourSynth](http://www.vapoursynth.com/) **r24+** installed – [Python](https://www.python.org/downloads/windows/) is a prerequisite for VapourSynth!
 * YV16/YV24 color spaces require Avisynth 2.6 (see section 10)
 
-Simple x264 Launcher is 100% standalone, i.e. it does **not** require Mircrosoft.NET, Java Runtime Environment or other dependencies.
-
-The required Qt DLLs and encoder binaries are included in the setup.
-
 
 # Anti-Virus Warning #
 
@@ -48,7 +49,7 @@ Occasionally your Antivirus program may mistakenly detect "malware" (virus, troj
 
 # License #
 
-Simple x264/x265 Launcher is Copyright (C) 2004-2015 LoRd_MuldeR.
+Simple x264/x265 Launcher is Copyright (C) 2004-2016 LoRd_MuldeR.
 
 ```
 This program is free software; you can redistribute it and/or modify
@@ -77,11 +78,11 @@ The following third-party software is used by this application:
   http://qt.digia.com/
   Qt is a free software, released under the terms of GNU GPL, version 3.
 
-* The x264 encoder software is Copyright (C) 2003-2015 x264 project.
+* The x264 encoder software is Copyright (C) 2003-2016 x264 project.
   http://www.videolan.org/developers/x264.html
   x264 is a free software and is released under the terms of the GNU GPL.
 
-* The x265 encoder software is Copyright (C) 2013-2015 x265 project.
+* The x265 encoder software is Copyright (C) 2013-2016 x265 project.
   http://www.videolan.org/developers/x265.html
   x265 is a free software and is released under the terms of the GNU GPL.
 
@@ -89,7 +90,7 @@ The following third-party software is used by this application:
   http://avisynth.nl/index.php/Main_Page
   AviSynth is a free software, released under the terms of the GNU GPL.
 
-* VapourSynth is Copyright (c) 2012-2015 Fredrik Mellbin.
+* VapourSynth is Copyright (c) 2012-2016 Fredrik Mellbin.
   http://www.vapoursynth.com/
   VapourSynth is free software, released under the terms of the GNU LGPL.
 
@@ -102,6 +103,44 @@ Simple x264/x265 Launcher can be run in a "portable" mode. This may be helpful,
 
 ***Note:*** Regardless of whether you enable the *portable* mode or not, the Simple x264/x265 Launcher application is **always** "portable", in the sense that the program is fully self-contained. It does *not* require any "external" libraries or frameworks to be installed on the computer. The only exceptions here are Avisynth and VapourSynth, which have to be installed *separately*, if they are needed. The *sole* purpose of the *portable* mode is to control where the configuration files will be stored. There is **no** such thing as a separate "portable" version of Simple x264/x265 Launcher.
 
+## VapourSynth
+
+There now is a "portable" edition **VapourSynth** available, which *Simple x264/x265 Launcher* can use. For this purpose, download the "portable" edition VapourSynth an *extract* it into the sub-directory `extra\VapourSynth` inside of the Simple x264/x265 Launcher "main" directory (i.e. where the `x264_launcher.exe` file is located). More specifically, the *32-Bit* version of "portable" VapourSynth needs to go to the `extra\VapourSynth\core32` sub-directory and the *64-Bit* version needs to go to the `extra\VapourSynth\core64` sub-directory. Be aware, however, that "portable" VapourSynth requires **embeddable Python** to work! So, you *must* download Python as "embeddable zip file" from the Python web-site and extract that into the same sub-directory as the VapourSynth "portable" binaries. In the end, it should look like this:
+```
+InstallPath\
+├─ x264_launcher_portable.exe
+└─ extra\
+   └─ VapourSynth\
+      ├─ core32\
+      │  ├─ python35.dll     <32-Bit>
+      │  ├─ VapourSynth.dll  <32-Bit>
+      │  ├─ VSPipe.exe       <32-Bit>
+      │  └─ etc…
+      └─ core64\
+         ├─ python35.dll     <64-Bit>
+         ├─ VapourSynth.dll  <64-Bit>
+         ├─ VSPipe.exe       <64-Bit>
+         └─ etc…
+```
+
+## Avisynth
+
+There now is a "portable" edition **Avisynth** available, which *Simple x264/x265 Launcher* can use. For this purpose, download and run the standard Avisynth 2.6 (or later) installer, but be sure to select *"Standalone, Unpack Files only"* as the installation type! Note that this needs to be selected on the *"Choose Components"* page of the installer. This will create a "portable" version of Avisynth in the selected output directory. Let the installer *extract* the Avisynth files into the sub-directory `extra\Avisynth` inside of the Simple x264/x265 Launcher "main" directory (i.e. where the `x264_launcher.exe` file is located). More specifically, the *32-Bit* version of "portable" Avisynth needs to go to the `extra\Avisynth\x86` sub-directory and the *64-Bit* version needs to go to the `extra\Avisynth\x64` sub-directory. In the end, it should look like this:
+```
+InstallPath\
+├─ x264_launcher_portable.exe
+└─ extra\
+   └─ Avisynth\
+      ├─ x86\
+      │  ├─ avisynth.dll  <32-Bit>
+      │  ├─ devil.dll     <32-Bit>
+      │  └─ etc…
+      └─ x64\
+         ├─ avisynth.dll  <64-Bit>
+         ├─ devil.dll     <64-Bit>
+         └─ etc…
+```
+
 
 # Updating Your Encoder Binaries #
 
@@ -141,7 +180,7 @@ Note that x264 will now *only* try to load the OpenCL.DLL if you really use the
 
 # Command-line Syntax #
 
-**PLEASE NOTE:** These are parameters you can pass to Simple x264 Launcher, they can ***not*** be passed to x264 or x265 as "custom" parameters !!!
+**PLEASE NOTE:** These are parameters you can pass to Simple x264 Launcher (`x264_launcher.exe`), they can **NOT** be passed to x264 or x265 as "custom" parameters !!!
 
 The following command-line switches are available:
 ```
@@ -151,8 +190,9 @@ The following command-line switches are available:
 --[no-]force-enqueue ............. Append the next job to the queue
 --skip-avisynth-check ............ Skip Avisynth detection
 --skip-vapoursynth-check ......... Skip VapourSynth detection
+--skip-version-checks    ......... Skip x264/x265 version checks, NOT recommended!
 --force-cpu-no-64bit ............. Forcefully disable 64-Bit support
---no-deadlock-detection .......... Don't abort a processes on deadlock
+--no-deadlock-detection .......... Do not abort a sub-process on possible deadlock
 --[no-]console ................... Do [not] show the Debug console
 --no-style ....................... Don't use the Qt "Plastique" style
 ```
@@ -193,7 +233,7 @@ Simple x264/x265 Launcher is written in C++ and currently developed with Microso
 The source codes can be obtained from the official Git repository:
 
 * https://github.com/lordmulder/Simple-x264-Launcher
-* https://gitorious.org/simple-x264-launcher/simple-x264-launcher
+* https://gitlab.com/simple-x264-launcher/simple-x264-launcher/
 * https://bitbucket.org/lord_mulder/simple-x264-launcher/src
 * https://www.assembla.com/code/simple-x264-x265-launcher/git/nodes
 * https://x264launcher.codeplex.com/SourceControl/latest
@@ -203,6 +243,7 @@ Download Visual Studio Express 2013 for Windows *Desktop* here:
 
 Download the latest Qt toolkit (4.8.x) from the Qt Project web-site:
 * http://download.qt-project.org/official_releases/qt/4.8/
+* http://sourceforge.net/projects/lamexp/files/Miscellaneous/Qt%20Libraries/
 
 &nbsp;  
 &nbsp;