Prepare to rename project into hashcat

[hashcat.git] / docs / BUILD.md

diff --git a/docs/BUILD.md b/docs/BUILD.md
index b495eb6..2791863 100644 (file)
--- a/docs/BUILD.md
+++ b/docs/BUILD.md
@@ -1,39 +1,19 @@
-oclHashcat build documentation
+hashcat build documentation
 =
 # Revision:
-* 1.1
+* 1.3
 
 # Authors:
 * Gabriele Gristina <<matrix@hashcat.net>>
 * Christoph Heuwieser <<dropdead@hashcat.net>>
+* magnum <<john.magnum@hushmail.com>>
 
-# Dependencies
+# Building hashcat for Linux and OSX
 
-To compile **oclHashcat** the following third party libraries are required:
-
-- ADL_SDK v8.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_SDK8.zip
-    R352-developer.zip
-    gdk_linux_amd64_352_55_release.run
-    
-# Building oclHashcat
-First get a copy of **oclHashcat** repository
+Get a copy of the **hashcat** repository
 
 ```sh
-$ git clone https://github.com/hashcat/oclHashcat.git
-```
-Install the dependencies
-
-```sh
-$ cd oclHashcat
-$ sudo ./tools/deps.sh
+$ git clone https://github.com/hashcat/hashcat.git
 ```
 
 Run "make"
@@ -42,25 +22,35 @@ Run "make"
 $ make
 ```
 
-to install it run "make install"
+# Install hashcat for Linux
+
+The install target is linux FHS compatible and can be used like this:
 
 ```sh
 $ make install
 ```
 
-Useful tricks:
-- build all binaries (see Note1):
+If you install it, cached kernels, session files, restore- and pot-files etc. will go to $HOME/.hashcat/
+
+# Building hashcat for Windows
+
+Get a copy of the **hashcat** repository
+
 ```sh
-$ make binaries
+$ git clone https://github.com/hashcat/hashcat.git
 ```
 
-Note1: to install all binaries ("make binaries") you need to first clone the OpenCL-Headers within the main folder:
+Basically all you need is the OpenCL Headers.
+
+Simply clone into the reference Implementation:
 
 ```sh
+$ mkdir -p deps/OpenCL-Headers
 $ 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.
-
+```sh
+$ make win32 win64
+```
 =
-Enjoy your fresh **oclHashcat** binaries ;)
+Enjoy your fresh **hashcat** binaries ;)