Update BUILD.md to current situation
authorJens Steube <jens.steube@gmail.com>
Wed, 27 Jan 2016 18:34:40 +0000 (19:34 +0100)
committerJens Steube <jens.steube@gmail.com>
Wed, 27 Jan 2016 18:34:40 +0000 (19:34 +0100)
docs/BUILD.md

index 456d345..6fc806c 100644 (file)
@@ -7,32 +7,13 @@ oclHashcat build documentation
 * Gabriele Gristina <<matrix@hashcat.net>>
 * Christoph Heuwieser <<dropdead@hashcat.net>>
 
-# Dependencies
+# Building oclHashcat for Linux and OSX
 
-To compile **oclHashcat** the following third party libraries are required:
-
-- ADL_SDK v9.0 ( http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ )
-- NVAPI R352 ( https://developer.nvidia.com/nvapi )
-- GDK v352_55 ( https://developer.nvidia.com/gpu-deployment-kit )
-
-The next thing to do is download all the third party libraries listed above and put these files into the *deps/tmp* directory.
-
-The following files are needed inside the *deps/tmp* directory:
-
-    R352-developer.zip  (only needed when cross-compiling for Windows)
-
-# Building oclHashcat
 First get a copy of the **oclHashcat** repository
 
 ```sh
 $ git clone https://github.com/hashcat/oclHashcat.git
 ```
-Install the dependencies (root permission needed)
-
-```sh
-$ cd oclHashcat
-$ ./tools/deps.sh
-```
 
 Run "make"
 
@@ -46,38 +27,35 @@ to install it run "make install"
 $ make install
 ```
 
-Useful tricks:
-- build native linux/osx binaries
-```sh
-$ make
-```
+# Building oclHashcat for Windows
 
-- build all binaries (see Note1 and Note2):
-```sh
-$ make binaries
-```
+The following third party library is required:
 
-Note1: to install all binaries ("make binaries") you need to first clone the OpenCL-Headers within the main folder:
+- NVAPI R352 ( https://developer.nvidia.com/nvapi )
 
-```sh
-$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
-```
+Download the third party library listed above and put the .zip file into the *deps/tmp* directory.
 
-the tools/deps.sh script does not clone this repo automatically since for native compilation it is not needed.
+- R352-developer.zip 
 
-Note2: if you get an error like the following one for "make binaries"
+Install the dependencies (root permission needed for apt-get install command)
 
 ```sh
-/usr/bin/ld: cannot find -lOpenCL
+$ ./tools/deps.sh
 ```
 
-the main reason is probably that the 32-bit version of libOpenCL.so was not found.
+- build all binaries:
 
-A possible solution is to just symbolic link it (if the 32-bit version of libOpenCL.so.1 exists), for example:
+```sh
+$ make win32 win64
+```
+
+# To build all binaries ("make binaries") you need to first clone the OpenCL-Headers within the main folder:
 
 ```sh
-sudo ln -s /usr/lib/i386-linux-gnu/libOpenCL.so.1 /usr/lib/i386-linux-gnu/libOpenCL.so
+$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
 ```
 
+the tools/deps.sh script does not clone this repo automatically since for native compilation it is not needed.
+
 =
 Enjoy your fresh **oclHashcat** binaries ;)