From: jsteube Date: Tue, 10 May 2016 17:16:57 +0000 (+0200) Subject: Moved BUILD.md to root folder X-Git-Tag: v3.00-beta X-Git-Url: https://www.flypig.org.uk/git/?p=hashcat.git;a=commitdiff_plain;h=refs%2Ftags%2Fv3.00-beta Moved BUILD.md to root folder --- diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..0528999 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,49 @@ +hashcat build documentation += +# Revision: +* 1.3 + +# Authors: +* Gabriele Gristina <> +* Christoph Heuwieser <> +* magnum <> + +# Building hashcat for Linux and OSX + +Get a copy of the **hashcat** repository + +```sh +$ git clone https://github.com/hashcat/hashcat.git +``` + +Get a copy of the **OpenCL Headers** repository + +```sh +$ mkdir -p deps/OpenCL-Headers +$ git clone https://github.com/KhronosGroup/OpenCL-Headers deps/OpenCL-Headers/CL +``` + +Run "make" + +```sh +$ make +``` + +# Install hashcat for Linux + +The install target is linux FHS compatible and can be used like this: + +```sh +$ make install +``` + +If you install it, cached kernels, session files, restore- and pot-files etc. will go to $HOME/.hashcat/ + +# Building hashcat for Windows + +```sh +$ make win32 win64 +``` + += +Enjoy your fresh **hashcat** binaries ;) diff --git a/README.md b/README.md index 12884e0..c79a63c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## *hashcat* ## -**hashcat** is the world's fastest and most advanced password recovery utility, supporting five unique modes of attack for over 180 highly-optimized hashing algorithms. hashcat currently supports CPU's, GPU's other hardware-accelerators on Linux, Windows and OSX, and has facilities to help enable distributed password cracking. +**hashcat** is the world's fastest and most advanced password recovery utility, supporting five unique modes of attack for over 160 highly-optimized hashing algorithms. hashcat currently supports CPU's, GPU's other hardware-accelerators on Linux, Windows and OSX, and has facilities to help enable distributed password cracking. ** THE VERSION 3.00 IS CURRENTLY STILL IN BETA ** @@ -18,7 +18,7 @@ Please refer to the [Hashcat Wiki](https://hashcat.net/wiki/) and the output of ### Building ### -Refer to [docs/BUILD.md](docs/BUILD.md) for instructions on how to build **hashcat** from source. +Refer to [BUILD.md](BUILD.md) for instructions on how to build **hashcat** from source. ### Contributing ### diff --git a/docs/BUILD.md b/docs/BUILD.md deleted file mode 100644 index 2791863..0000000 --- a/docs/BUILD.md +++ /dev/null @@ -1,56 +0,0 @@ -hashcat build documentation -= -# Revision: -* 1.3 - -# Authors: -* Gabriele Gristina <> -* Christoph Heuwieser <> -* magnum <> - -# Building hashcat for Linux and OSX - -Get a copy of the **hashcat** repository - -```sh -$ git clone https://github.com/hashcat/hashcat.git -``` - -Run "make" - -```sh -$ make -``` - -# Install hashcat for Linux - -The install target is linux FHS compatible and can be used like this: - -```sh -$ make install -``` - -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 -$ git clone https://github.com/hashcat/hashcat.git -``` - -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 -``` - -```sh -$ make win32 win64 -``` -= -Enjoy your fresh **hashcat** binaries ;)