Prepare to rename project into hashcat
[hashcat.git] / docs / BUILD.md
1 hashcat build documentation
2 =
3 # Revision:
4 * 1.3
5
6 # Authors:
7 * Gabriele Gristina <<matrix@hashcat.net>>
8 * Christoph Heuwieser <<dropdead@hashcat.net>>
9 * magnum <<john.magnum@hushmail.com>>
10
11 # Building hashcat for Linux and OSX
12
13 Get a copy of the **hashcat** repository
14
15 ```sh
16 $ git clone https://github.com/hashcat/hashcat.git
17 ```
18
19 Run "make"
20
21 ```sh
22 $ make
23 ```
24
25 # Install hashcat for Linux
26
27 The install target is linux FHS compatible and can be used like this:
28
29 ```sh
30 $ make install
31 ```
32
33 If you install it, cached kernels, session files, restore- and pot-files etc. will go to $HOME/.hashcat/
34
35 # Building hashcat for Windows
36
37 Get a copy of the **hashcat** repository
38
39 ```sh
40 $ git clone https://github.com/hashcat/hashcat.git
41 ```
42
43 Basically all you need is the OpenCL Headers.
44
45 Simply clone into the reference Implementation:
46
47 ```sh
48 $ mkdir -p deps/OpenCL-Headers
49 $ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL
50 ```
51
52 ```sh
53 $ make win32 win64
54 ```
55 =
56 Enjoy your fresh **hashcat** binaries ;)