Prepare to rename project into hashcat

[hashcat.git] / docs / BUILD.md

diff --git a/docs/BUILD.md b/docs/BUILD.md
index a04ba4a..2791863 100644 (file)
--- a/docs/BUILD.md
+++ b/docs/BUILD.md
@@ -1,67 +1,56 @@
-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:
+Get a copy of the **hashcat** repository
 
-- ADL_SDK v8.0 ( http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ )
-- cuda v7.5 ( https://developer.nvidia.com/cuda-downloads )
-- GDK v352_55 ( https://developer.nvidia.com/gpu-deployment-kit )
-- NVIDIA Driver v352.21 ( https://www.nvidia.com/download/driverResults.aspx/86390/en-us )
-- NVAPI R352 ( https://developer.nvidia.com/nvapi )
-- AMD-APP-SDK v3.0 ( http://developer.amd.com/tools-and-sdks/opencl-zone/amd-accelerated-parallel-processing-app-sdk/ )
+```sh
+$ git clone https://github.com/hashcat/hashcat.git
+```
 
-To be able to compile the ocl binaries, it is required to have the latest stable driver from AMD installed.
-(fglxr must be installed and initialized)
+Run "make"
 
-    http://support.amd.com/
+```sh
+$ make
+```
 
-The next thing to do is download all the third party libraries listed above and put these files into the *deps/tmp* directory.
+# Install hashcat for Linux
 
-The following files are needed inside the *deps/tmp* directory:
-    
-    ADL_SDK8.zip
-    R352-developer.zip
-    cuda_7.5.18_linux.run
-    NVIDIA-Linux-x86_64-352.21.run
-    gdk_linux_amd64_352_55_release.run
-    AMD-APP-SDKInstaller-v3.0.130.135-GA-linux64.tar.bz2
-    
-# Building oclHashcat
-First get a copy of **oclHashcat** repository
+The install target is linux FHS compatible and can be used like this:
 
 ```sh
-$ git clone https://github.com/hashcat/oclHashcat.git
+$ make install
 ```
-Install the dependencies
 
-```sh
-$ cd oclHashcat
-$ sudo ./tools/deps.sh
-```
+If you install it, cached kernels, session files, restore- and pot-files etc. will go to $HOME/.hashcat/
 
-Run "make all"
+# Building hashcat for Windows
+
+Get a copy of the **hashcat** repository
 
 ```sh
-$ make all
+$ git clone https://github.com/hashcat/hashcat.git
 ```
 
-Useful tricks:
-- build only *Linux* binaries
+Basically all you need is the OpenCL Headers.
+
+Simply clone into the reference Implementation:
+
 ```sh
-$ make linux
+$ mkdir -p deps/OpenCL-Headers
+$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
 ```
-- build only *Windows* binaries
+
 ```sh
-$ make windows
+$ make win32 win64
 ```
-
 =
-Enjoy your fresh **oclHashcat** binaries ;)
+Enjoy your fresh **hashcat** binaries ;)