diff --git a/BUILD.md b/BUILD.md index 323c9a66a..490b9b848 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,37 +1,45 @@ hashcat build documentation = -# Revision: + +### Revision ### + * 1.4 -# Author: see docs/credits.txt +### Author ### + +See docs/credits.txt -# Building hashcat for Linux, macOS and Windows (using Cygwin or MSYS2) +### Building hashcat for Linux, macOS and Windows (using Cygwin) ### Get a copy of the **hashcat** repository -```sh +``` $ git clone https://github.com/hashcat/hashcat.git ``` Run "make" -```sh +``` $ make ``` -# Install hashcat for Linux +### Building hashcat for Windows (using MSYS2) ### + +Refer to [BUILD_MSYS2.md](BUILD_MSYS2.md) + +### 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 from Linux +### Building hashcat for Windows from Linux ### -```sh +``` $ make win ``` diff --git a/docs/msys2_win.md b/BUILD_msys2.md similarity index 82% rename from docs/msys2_win.md rename to BUILD_msys2.md index 15d3085df..e2e3b57e2 100644 --- a/docs/msys2_win.md +++ b/BUILD_msys2.md @@ -2,35 +2,45 @@ Tested on a Windows 7 SP1 x64 machine. +### Installation ### + Go to https://www.msys2.org/ and follow the instructions on the main page (steps 1 to 7). Install additional dependencies required to compile hashcat by running the following commands: -```sh + +``` $ pacman -S git $ pacman -S make $ pacman -S gcc $ pacman -S libiconv-devel ``` +### Building ### + Once all that is done, type the following command to copy the latest master revision of hashcat repository into msys64\home\username\hashcat -```sh + +``` $ git clone https://github.com/hashcat/hashcat.git ``` Switch to the newly created folder by runnig -```sh + +``` $ cd hashcat ``` Now type "make" to start compiling hashcat -```sh + +``` $ make ``` -The process may take a while, please be patient. -Once it's finished, run hashcat by typing "./hashcat.exe". -```sh +The process may take a while, please be patient. Once it's finished, run hashcat by typing "./hashcat.exe". + +``` $ ./hashcat.exe ``` +### Notes ### + While hashcat will run fine from msys shell, running it from a windows shell will require msys-iconv-2.dll and msys-2.0.dll to be in the same folder with hashcat.exe (the files can be found in msys64\usr\bin).