@@ -28,7 +28,18 @@ The python module needs to execute the `differ` executable. As such it should be
28
28
Usage as a python module
29
29
------------------------
30
30
31
- The simplest way to get the programs diffed is:
31
+ The simplest way to get the programs, already exported with BinExport, diffed, is:
32
+
33
+ ``` python
34
+ from bindiff import BinDiff
35
+
36
+ diff = BinDiff.from_binary_files(" sample1.exe" , " sample2.exe" , " out.BinDiff" )
37
+
38
+ # or performing the diff on BinExport files
39
+ diff = BinDiff.from_binexport_files(" sample1.BinExport" , " sample2.BinExport" , " out.BinDiff" )
40
+ ```
41
+
42
+ To load the diffing results of an ** existing** diff.BinDiff file, do:
32
43
33
44
``` python
34
45
from bindiff import BinDiff
@@ -56,14 +67,6 @@ after instanciating BinDiff those ``p1`` and ``p2`` are modified.**
56
67
From the API it is also possible to directly perform the BinExport
57
68
extraction and the diffing:
58
69
59
- ``` python
60
- from bindiff import BinDiff
61
-
62
- diff = BinDiff.from_binary_files(" sample1.exe" , " sample2.exe" , " out.BinDiff" )
63
-
64
- # or performing the diff on BinExport files
65
- diff = BinDiff.from_binexport_files(" sample1.BinExport" , " sample2.BinExport" , " out.BinDiff" )
66
- ```
67
70
68
71
Usage as a command line
69
72
-----------------------
@@ -88,4 +91,4 @@ To work bindiff ``differ`` binary should be in the ``$PATH``, given via
88
91
the `` BINDIFF_PATH `` environment variable or with the `` -b `` command option.
89
92
Similarly when diff binaries directly the ida64 binary should be available
90
93
in the $PATH, given with the `` IDA_PATH `` environment variable or via the
91
- `` -i `` command option.
94
+ `` -i `` command option.
0 commit comments