Compiling instructions

In order to use our whisper-library you first need to have a compiled copy of it on your computer.

Compiling the whisper-library on Linux

1. Make sure the following programs are installed

1.1 git - or download a copy from the library at https://github.com/UndeadKernel/whisper-library and skip step 2.
	Ubuntu: "sudo apt-get install git"

1.2 cmake
	Ubuntu: "sudo apt-get install cmake"

1.3 gcc and g++
	Ubuntu: "sudo apt-get install g++"

1.4 libcap 1.51 or higher
	in case of configuration or installation problems you might want to look at the INSTALL.txt in the libcap main directory.
	(you might need to install "flex" and "yacc", which is part of the "bison" package, to compile libcap)

	1.4.1 Download the latest version from tcpdump.org and extract it
	1.4.2 switch to extracted folder
	1.4.3 "./configure"
	1.4.4 "make"
	1.4.5 "sudo make install"
	1.4.6 add the current directory either to your system Path variable or set it in the PCAP_ROOT variable.

1.5 Boost 1.55 or higher
	1.5.1 Download the latest version from boost.org and extract and switch into it
	1.5.2 "./bootstrap.sh"
	1.5.3 "sudo ./b2 install"

	See here for a full installation description for linux: 
	http://www.boost.org/doc/libs/1_55_0/more/getting_started/unix-variants.html

2. Creating a clone from the current github repository

2.1 Open a terminal

2.2 Either switch to a folder which you want to use to store the library or create a new one and switch into it.

2.3 Type in "git clone https://github.com/UndeadKernel/whisper-library.git"

3. Compiling the whisper library

3.1 Switch to the project root folder "whisper-library"

3.2 Type in "cmake ."

3.3 "make"

The library should now get compiled without problems, if you however still encounter one please let us know.

Compiling the whisper-library on Windows

1. Make sure the following programs are installed

1.1 git ( http://git-scm.com ) or the GitHub UI ( https://windows.github.com/ )
	you can also alternatively download a copy from the library at https://github.com/UndeadKernel/whisper-library and skip step 2.

1.2 cmake ( www.cmake.org ) - check to add the executables to the system path
	
1.3 Visual Studio 2013 or higher
	older versions might work, but are untested.

1.4 WinPcap Driver ( http://www.winpcap.org/install/default.htm )

1.5 WinPcap Developer Pack ( http://www.winpcap.org/devel.htm )
	1.5.1 extract it
	1.5.2 add the root folder "WpdPack" either to your system path or to a new environment variable "PCAP_ROOT"
	(note that changes to the system path might require a restart to take effect)

1.5 Boost 1.55 or higher
	1.5.1 Download the latest version from boost.org and extract it
	1.5.2 execute "bootstrap.bat"
	1.5.3 start "b2" with elevated privileges (right click and "Start as Administrator")
	1.5.4 add the boost root folder to your system path (e.g. "C:\wlib\boost_1_55_00\")

2. Creating a clone from the current github repository

2.1 Open a "Git Bash" terminal

2.2 Either switch to the folder ( "cd FOLDERNAME" ) you want to use 
    or create a new one ( "mkdir FOLDERNAME") and switch into it.

2.3 Type in "git clone https://github.com/UndeadKernel/whisper-library.git"

3. Compiling the whisper library

3.1 start the cmake-gui

3.2 select as source folder the root folder of the project ("whisper-library")

3.3 Choose a folder of your liking as output folder for the binaries.

3.4 Select "Generate" ( and choose native compilers if you're starting cmake-gui for the first time ).

3.5 Open a terminal (git bash or cmd are fine) switch to your binary output folder and run "cmake --build"
	alternatively you can open the generated whisperLibrary\whisperLibrary.vcxproj in Visual Studio
	and build it with the internal tools.

The library should now get compiled without problems, if you however still encounter one please let us know.