Skip to content

Commit

Permalink
Fixed dependency issue; added README for crates.io
Browse files Browse the repository at this point in the history
  • Loading branch information
devttys0 committed Oct 31, 2024
1 parent cf71533 commit 5f41f8d
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CARGO_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## binwalk

A Rust implementation of the Binwalk firmware analysis tool.

## System Requirements

Building requires the following system packages:

```
build-essential libfontconfig1-dev liblzma-dev
```

## Example

```
use binwalk::Binwalk;
// Create a new Binwalk instance
let binwalker = Binwalk::new();
// Read in the data to analyze
let file_data = std::fs::read("/tmp/firmware.bin").expect("Failed to read from file");
// Scan the file data and print the results
for result in binwalker.scan(&file_data) {
println!("{:#?}", result);
}
```
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version = "3.1.0"
edition = "2021"
authors = ["Craig Heffner <heffnercj@gmail.com>"]
license = "MIT"
readme = "CARGO_README.md"
repository = "https://github.com/ReFirmLabs/binwalk"
description = "Analyzes data for embedded file types"
keywords = ["binwalk", "firmware", "analysis"]
Expand Down
1 change: 1 addition & 0 deletions dependencies/ubuntu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt-get -y install \
p7zip-full \
zstd \
tar \
unzip \
sleuthkit \
cabextract \
curl \
Expand Down
10 changes: 10 additions & 0 deletions fuzzing/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5f41f8d

Please sign in to comment.