BEFORE YOU START
-----------------------------------------

Binwalk supports Python 2.7 - 3.x. Although binwalk is slightly faster in Python 3, the Python OpenGL bindings
are still experimental for Python 3, so Python 2.7 is recommended.

The following installation procedures assume that you are installing binwalk to be run using Python 2.7.
If you want to use binwalk in Python 3, some package names and installation procedures may differ slightly.

You will also need to have a C compiler installed to build the supporting C libraries.



INSTALLATION
-----------------------------------------

Installation follows the typical configure/make process:

    $ ./configure
    $ make deps          # Skip this if you don't want extraction utilities and dependencies auto-installed
    $ make
    $ sudo make install

Note that 'make deps' should work on most Debian and RedHat based systems. If this does not work for your system, 
see below for manaully installing dependencies / extraction utilities.



MANUALLY INSTALLING DEPENDENCIES
-----------------------------------------

Most binwalk features will work out of the box without any additional dependencies. However, to take advantage
of binwalk's graphing capabilities, you need to install the following dependencies (you may also need to install 
OpenGL drivers for your video card):
    
    $ sudo apt-get install libqt4-opengl python-opengl python-qt4 python-qt4-gl python-numpy python-scipy



MANUALLY INSTALLING EXTRACTION UTILITIES
-------------------------------------------

Binwalk can automatically invoke external extraction utilities to extract various types of files that it may find during 
a scan. These utilities are optional, but recommended if you plan on using binwalk's extraction features.

Most utilities can be installed from your distro's repositories (package names may vary slightly based
on your particular distro):

    $ sudo apt-get install git mtd-utils zlib1g-dev liblzma-dev ncompress gzip bzip2 tar arj p7zip p7zip-full openjdk-6-jdk

However, the Firmware-Mod-Kit, which contains many file system extractors, needs to be built from source
and placed in the /opt/firmware-mod-kit directory:

    $ sudo mkdir -p /opt/firmware-mod-kit
    $ sudo chmod -R a+rwx /opt/firmware-mod-kit
    $ git clone https://code.google.com/p/firmware-mod-kit /opt/firmware-mod-kit/
    $ cd /opt/firmware-mod-kit/src && ./configure && make



UNINSTALL
-----------------------------------------

The following command will remove binwalk from your system (note that this does *not* include dependencies installed via 'make deps'):

    $ sudo make uninstall

