Merge branch 'master' into GetRidOfCUDA
[hashcat.git] / docs / BUILD.md
1 oclHashcat build documentation
2 =
3 # Revision:
4 * 1.1
5
6 # Authors:
7 * Gabriele Gristina <<matrix@hashcat.net>>
8 * Christoph Heuwieser <<dropdead@hashcat.net>>
9
10 # Dependencies
11
12 To compile **oclHashcat** the following third party libraries are required:
13
14 - ADL_SDK v8.0 ( http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ )
15 - GDK v352_55 ( https://developer.nvidia.com/gpu-deployment-kit )
16 - NVIDIA Driver v352.21 ( https://www.nvidia.com/download/driverResults.aspx/86390/en-us )
17 - NVAPI R352 ( https://developer.nvidia.com/nvapi )
18 - AMD-APP-SDK v3.0 ( http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/ )
19
20 To be able to compile the ocl binaries, it is required to have the latest stable driver from AMD installed.
21 (fglxr must be installed and initialized)
22
23     http://support.amd.com/
24
25 The next thing to do is download all the third party libraries listed above and put these files into the *deps/tmp* directory.
26
27 The following files are needed inside the *deps/tmp* directory:
28     
29     ADL_SDK8.zip
30     R352-developer.zip
31     NVIDIA-Linux-x86_64-352.21.run
32     gdk_linux_amd64_352_55_release.run
33     AMD-APP-SDKInstaller-v3.0.130.135-GA-linux64.tar.bz2
34     
35 # Building oclHashcat
36 First get a copy of **oclHashcat** repository
37
38 ```sh
39 $ git clone https://github.com/hashcat/oclHashcat.git
40 ```
41 Install the dependencies
42
43 ```sh
44 $ cd oclHashcat
45 $ sudo ./tools/deps.sh
46 ```
47
48 Run "make all"
49
50 ```sh
51 $ make all
52 ```
53
54 Useful tricks:
55 - build only *Linux* binaries
56 ```sh
57 $ make linux
58 ```
59 - build only *Windows* binaries
60 ```sh
61 $ make windows
62 ```
63
64 =
65 Enjoy your fresh **oclHashcat** binaries ;)