Skip to content

Commit

Permalink
show info about EOL of binwalk2
Browse files Browse the repository at this point in the history
  • Loading branch information
stkw0 committed Nov 6, 2024
1 parent ffa980d commit a1cd1c3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@

Binwalk is a fast, easy to use tool for analyzing, reverse engineering, and extracting firmware images.

### Binwalkv3
### EOL notice

Original binwalk authors started to rewrite it to rust. For now it's unstable/experimental but it comes with multiple improvements. See https://github.com/ReFirmLabs/binwalk for more information.
This fork was born to fix some outsanding issues with binwalk v2 and generally to keep it in good shape. It served his purpose helping users and distro packagers alike. However, given the original author recently rewrote binwalk in rust and is in active development again, there is no need to maintain binwalk v2 anymore. Users and contributors should migrate to binwalk v3. This new version also provides a library in Rust, see https://github.com/ReFirmLabs/binwalk/wiki/Using-the-Rust-Library.

As a result, **this repository will effectively be EOL at 12/12/2025**, at which point this repository may be archived or removed.

-----

### Important notice

Expand Down
2 changes: 2 additions & 0 deletions src/binwalk/core/module.py
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,8 @@ def help(self):
fmt = " %%s %%s%%-%ds%%s\n" % (25 - len(long_opt))
help_string += fmt % (short_opt, long_opt, optargs, module_option.description)

help_string += "\n[NOTICE] Binwalk v2.x will reach EOL in 12/12/2025. Please migrate to binwalk v3.x"

return help_string + "\n"

def execute(self, *args, **kwargs):
Expand Down

0 comments on commit a1cd1c3

Please sign in to comment.