Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BugsBound committed Jun 26, 2023
1 parent e12df23 commit e3dde85
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

BIN Patcher is a simple Rust-based program for patching BIN files.

![Demo](./demo.gif)
![Demo](./gif/demo.gif)

## Description

Expand Down Expand Up @@ -42,6 +42,28 @@ Example of use:
bin_patcher -f /path/to/your/file.bin -b deadbeef -a 0x400
```

### Options

**-a, --address <ADDRESS>**

Address in memory for re-write. Should be in hexadecimal format, for example: `-a 0x400`.

**-b, --bytes <BYTES>**

Bytes to write. Should be a string of hexadecimal values, for example: `-b deadbeef`.

**-f, --file <FILE>**

Path to the BIN file that will be modified. Can be either absolute or relative to the current directory, for example: `-f /path/to/your/file.bin`.

**-h, --help**

Prints help information, displaying a short description of the program and a list of all available options.

**-V, --version**

Prints the current version of the program.

## License

This project is licensed under the MIT License - see the `LICENSE` file for details.
Expand All @@ -53,4 +75,4 @@ This project is open for community contribution. We welcome any ideas and sugges
## Disclaimer
This code is provided for educational and informational purposes only. Use this code responsibly and ensure that you have proper authorization to test or exploit a target system. Using this code without permission on systems you don't own or have legal authorization to access is illegal. The author disclaim any responsibility for any misuse or illegal activities performed with this code.

**Use at your own risk!**
### **Use at your own risk!**
Binary file added gif/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e3dde85

Please sign in to comment.