diff x265/build/README.txt @ 0:772086c29cc7

Initial import.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 16 Nov 2016 11:16:33 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/x265/build/README.txt	Wed Nov 16 11:16:33 2016 +0200
@@ -0,0 +1,71 @@
+= Mandatory Prerequisites =
+
+* GCC, MSVC (9, 10, 11, 12), Xcode or Intel C/C++
+* CMake 2.8.8 or later http://www.cmake.org
+* On linux, ccmake is helpful, usually a package named cmake-curses-gui 
+
+Note: MSVC12 requires cmake 2.8.11 or later
+
+
+= Optional Prerequisites =
+
+1. Yasm 1.2.0 or later, to compile assembly primitives (performance)
+
+   For Windows, download the latest yasm executable
+   http://yasm.tortall.net/Download.html and copy the EXE into
+   C:\Windows or somewhere else in your %PATH% that a 32-bit app (cmake)
+   can find it. If it is not in the path, you must manually tell cmake
+   where to find it.  Note: you do not need the vsyasm packages, x265
+   does not use them.  You only need the yasm executable itself.
+
+   On Linux, the packaged yasm may be older than 1.2, in which case
+   so you will need get the latest source and build it yourself.
+
+   Once YASM is properly installed, run cmake to regenerate projects. If you
+   do not see the below line in the cmake output, YASM is not in the PATH.
+
+   -- Found Yasm 1.3.0 to build assembly primitives
+
+   Now build the encoder and run x265 -V:
+
+   x265 [info]: using cpu capabilities: MMX, SSE2, ...
+
+   If cpu capabilities line says 'none!', then the encoder was built
+   without yasm.
+
+2. VisualLeakDetector (Windows Only)
+
+   Download from https://vld.codeplex.com/releases and install. May need
+   to re-login in order for it to be in your %PATH%.  Cmake will find it
+   and enable leak detection in debug builds without any additional work.
+
+   If VisualLeakDetector is not installed, cmake will complain a bit, but
+   it is completely harmless.
+
+
+= Build Instructions Linux =
+
+1. Use cmake to generate Makefiles: cmake ../source
+2. Build x265:                      make
+
+  Or use our shell script which runs cmake then opens the curses GUI to
+  configure build options
+
+1. cd build/linux ; ./make-Makefiles.bash
+2. make
+
+
+= Build Instructions Windows =
+
+We recommend you use one of the make-solutions.bat files in the appropriate
+build/ sub-folder for your preferred compiler.  They will open the cmake-gui
+to configure build options, click configure until no more red options remain,
+then click generate and exit.  There should now be an x265.sln file in the
+same folder, open this in Visual Studio and build it.
+
+= Version number considerations =
+
+Note that cmake will update X265_VERSION each time cmake runs, if you are
+building out of a Mercurial source repository.  If you are building out of
+a release source package, the version will not change.  If Mercurial is not
+found, the version will be "unknown".