Import new version from debian
[packages/binwalk.git] / README.md
1 Description
2 ===========
3
4 Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extracting firmware images.
5
6 Installation
7 ============
8
9 Binwalk follows the standard Unix configure/make installation procedure:
10
11     $ ./configure
12     $ make
13     $ sudo make install
14
15 For convenience, optional dependencies for automatic extraction and graphical visualizations can be installed by running the included `deps.sh` script:
16
17     $ ./deps.sh
18
19 If your system is not supported by `deps.sh`, or if you wish to manually install dependencies, see `INSTALL.md`.
20
21 For advanced installation options, see `INSTALL.md`.
22
23 Usage
24 =====
25
26 Basic usage is simple:
27
28     $ binwalk firmware.bin
29
30 For additional examples and desriptions of advanced options, see the [wiki](https://github.com/devttys0/binwalk/wiki).