Skip to content

Commit 2036b3d

Browse files
committed
Add instructions for radare2 support to the readme.
1 parent 9659e9f commit 2036b3d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ The basic process is simple and looks like this:
2121

2222
1. Clone the repo to your local machine
2323
2. Place the repo into your Binary Ninja plugins directory, or create a symlink pointing to it.
24-
3. (Optional) Install PyQt5 - The latest version of ripr does not require this.
24+
3. (Optional) Add `(ripr addr, #!pipe python /absolute/path/to/ripr/r2pipe_run.py $0)` to your `.radare2rc`.
25+
4. (Optional) Install PyQt5 - The latest version of ripr does not require this.
2526

2627
#### Windows
2728
Installation on Windows typically requires installing PyQt5.
@@ -35,6 +36,7 @@ Installation on Windows typically requires installing PyQt5.
3536
---
3637

3738
#### Packaging a Function
39+
##### Binary Ninja
3840
From within Binary Ninja, right click anywhere inside of a function and select `[ripr] Package Function`.
3941

4042
<img src="https://puu.sh/thLAo/491ac39e58.PNG" width="600">
@@ -43,6 +45,10 @@ After packaging, a table will appear listing all of the "packages" you have crea
4345

4446
<img src="https://puu.sh/tnz8C/d0f5141f43.PNG" width="600">
4547

48+
##### Radare2
49+
If you've followed step 3 in the installation instructions, run `.(ripr 0x1234)` (with 0x1234 replaced by the address of the function).
50+
Otherwise, you can manually invoke ripr with `#!pipe python /absolute/path/to/ripr/r2pipe_run.py 0x1234`.
51+
4652
#### Packaging Specific Basic Blocks
4753
You can also choose to only package specific basic blocks rather than the entire function.
4854

0 commit comments

Comments
 (0)