Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ubfx committed Jul 26, 2023
1 parent c0fa78e commit 042e56d
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Check out the [BinDiff manual](https://www.zynamics.com/bindiff/manual/) to see
## What it does / Changelog

### v0.4.2
* Add function to import all functions (not just the ones checked in the table)
* Add function to toggle the checkbox for multiple elements in the table
* Update to support Ghidra 10.3

### v0.4.1
Expand Down Expand Up @@ -45,9 +47,11 @@ Check out the [BinDiff manual](https://www.zynamics.com/bindiff/manual/) to see
## How to Install
Either download the .zip-File from the [release](https://github.com/ubfx/BinDiffHelper/releases), if it's compatible to your Ghidra version, otherwise see *How to build* below.

Open Ghidra, go to **File->Install Extensions...** in the **Main Window**. Click the +-Button in the top right and select the BinDiffHelper zip file.

Close the plugin manager. Restart Ghidra to load the new plugin.
1. Open Ghidra
1. In the **Main Window**: Go to **File->Install Extensions...**
1. Click the +-Button in the top right and select the BinDiffHelper zip file
1. Close the plugin manager. Restart Ghidra to load the new plugin
1. See *Usage* below

## Recommended other tools
* BinExport plugin [binaries](https://github.com/google/binexport/releases) or compiled from [source](https://github.com/google/binexport/tree/master/java/BinExport) for your specific Ghidra version
Expand Down Expand Up @@ -109,6 +113,21 @@ There should have been a .zip-File created in the dist directory.

Use that .zip File to install according to the instructions above.

## Development / Debugging setup
Sometimes it's useful to be able to debug the extension together with Ghidra, here are some notes on that:

1. Clone and build Ghidra and let gradle create eclipse projects according to the DevGuide
1. Import the projects into eclipse (make sure it has relevant plugins for extension development)
1. Build and install GhidraDev
1. Unpack the Ghidra build and link GhidraDev to it. Maybe have to set GHIDRA_INSTALL_DIR environment variable
1. Run Ghidra from eclipse and install BinExport extension
1. Create BinDiffHelper eclipse project with `gradle build eclipse`
1. Import it into eclipse and use GhidraDev to link it to the Ghidra build
1. Debug As->Ghidra

When debugging Ghidra with the extension out of eclipse, the extension is loaded into Ghidra automatically (don't go through the usual extension install). However, the plugin has to be enabled in the Code Explorer.



## References
* https://www.zynamics.com/bindiff/manual/
Expand Down

0 comments on commit 042e56d

Please sign in to comment.