From a3b16128ed85912c1f5bf4f1eaa2cb95ee79bc6c Mon Sep 17 00:00:00 2001 From: Philip Rebohle Date: Fri, 17 Nov 2017 11:34:38 +0100 Subject: [PATCH] Create README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..6e09f735 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# DXVK + +Provides a Vulkan-based implementation of DXGI and D3D11 in order to run 3D applications on Linux using Wine. + +For the current status of the project, please refer to the [project wiki](https://github.com/doitsujin/dxvk/wiki). + +## Build instructions + +### Requirements: +- [Meson](http://mesonbuild.com/) build system +- [MinGW64](http://mingw-w64.org/) compiler and headers +- [SDL2](https://www.libsdl.org/) headers and DLL + +### Building DLLs +Inside the dxvk directory, run: +``` +meson --cross-file build-win64.txt build.w64 +cd build.w64 +meson configure -Dprefix=/your/directory +ninja +ninja install +``` + +Both `dxgi.dll` and `d3d11.dll`as well as some demo executables will be located in `/your/directory/bin`. 32-bit builds are currently not supported. + +## How to use +In order to run `executable.exe` with DXVK, +* Copy `dxgi.dll`, `d3d11.dll` and `SDL2.dll` into the same directory as the executable +* Run `WINEDLLOVERRIDES=d3d11,dxgi=n wine executable.exe` + +DXVK will create a file `dxvk.log` in the current working directory and may print out messages to stderr.