Add note about fixed issue #288 in changes.txt

[hashcat.git] / docs / BUILD.md

diff --git a/docs/BUILD.md b/docs/BUILD.md
index 49a3828..60a9e6d 100644 (file)
--- a/docs/BUILD.md
+++ b/docs/BUILD.md
@@ -1,40 +1,20 @@
 oclHashcat build documentation
 =
 # Revision:
-* 1.2
+* 1.3
 
 # Authors:
 * Gabriele Gristina <<matrix@hashcat.net>>
 * Christoph Heuwieser <<dropdead@hashcat.net>>
+* magnum <<john.magnum@hushmail.com>>
 
-# 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:
-    
-    ADL_SDK9.zip
-    R352-developer.zip
-    gdk_linux_amd64_352_55_release.run
-    
-# Building oclHashcat
-First get a copy of the **oclHashcat** repository
+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"
 
@@ -42,44 +22,35 @@ Run "make"
 $ make
 ```
 
-to install it run "make install"
+# Install oclHashcat for Linux
+
+The install target is linux FHS compatible and can be used like this:
 
 ```sh
 $ make install
 ```
 
-Useful tricks:
-- build native linux/osx binaries
-```sh
-$ make
-```
+If you install it, cached kernels, session files, restore- and pot-files etc. will go to $HOME/.hashcat/
 
-- build all binaries (see Note1 and Note2):
-```sh
-$ make binaries
-```
+# Building oclHashcat for Windows
 
-Note1: to install all binaries ("make binaries") you need to first clone the OpenCL-Headers within the main folder:
+Get a copy of the **oclHashcat** repository
 
 ```sh
-$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
+$ git clone https://github.com/hashcat/oclHashcat.git
 ```
 
-the tools/deps.sh script does not clone this repo automatically since for native compilation it is not needed.
+Basically all you need is the OpenCL Headers.
 
-Note2: if you get an error like the following one for "make binaries"
+Simply clone into the reference Implementation:
 
 ```sh
-/usr/bin/ld: cannot find -lOpenCL
+$ mkdir -p deps/OpenCL-Headers
+$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
 ```
 
-the main reason is probably that the 32-bit version of libOpenCL.so was not found.
-
-A possible solution is to just symbolic link it (if the 32-bit version of libOpenCL.so.1 exists), for example:
-
 ```sh
-sudo ln -s /usr/lib/i386-linux-gnu/libOpenCL.so.1 /usr/lib/i386-linux-gnu/libOpenCL.so
+$ make win32 win64
 ```
-
 =
 Enjoy your fresh **oclHashcat** binaries ;)