Unverified Commit f15879d3 by sorja Committed by GitHub

More informative README.md

Updated README.md to be more informative
parent e27014e3
# Binwalk # Binwalk
[![Build Status](https://travis-ci.org/ReFirmLabs/binwalk.svg?branch=master)](https://travis-ci.org/ReFirmLabs/binwalk) [![Build Status](https://travis-ci.org/ReFirmLabs/binwalk.svg?branch=master)](https://travis-ci.org/ReFirmLabs/binwalk)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/ReFirmLabs/binwalk/graphs/commit-activity)
[![GitHub license](https://img.shields.io/github/license/ReFirmLabs/binwalk.svg)](https://github.com/ReFirmLabs/binwalk/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Stars)](https://github.com/ReFirmLabs/binwalk/stargazers)
Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extracting firmware images. Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extracting firmware images.
## Installation
### Installation and Usage
* [Installation](./INSTALL.md)
* [API](./API.md)
* [Supported Platforms](https://github.com/ReFirmLabs/binwalk/wiki/Supported-Platforms)
* [Getting Started](https://github.com/ReFirmLabs/binwalk/wiki/Quick-Start-Guide)
* [Binwalk Command Line Usage](https://github.com/ReFirmLabs/binwalk/wiki/Usage)
* [Binwalk IDA Plugin Usage](https://github.com/ReFirmLabs/binwalk/wiki/Creating-Custom-Plugins)
* [Wiki](https://github.com/ReFirmLabs/binwalk/wiki)
## Quick start
### Installation
Binwalk follows the standard Python installation procedure: Binwalk follows the standard Python installation procedure:
```bash ```bash
...@@ -17,10 +33,10 @@ If you're running Python 2.x, installing the optional Python lzma module is stro ...@@ -17,10 +33,10 @@ If you're running Python 2.x, installing the optional Python lzma module is stro
$ sudo apt-get install python-lzma $ sudo apt-get install python-lzma
``` ```
For instructions on installing other optional dependencies, see [INSTALL.md](https://github.com/ReFirmLabs/binwalk/blob/master/INSTALL.md). For instructions on installing other optional dependencies, see [installation guide](https://github.com/ReFirmLabs/binwalk/blob/master/INSTALL.md).
## Usage ### Usage
Basic usage is simple: Basic usage is simple:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment