Skip to content

Commit

Permalink
README+user_guide: update description - mention x86-64 decompilation.
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterMatula committed Mar 19, 2019
1 parent ffecd0d commit 0bec63c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,15 @@ RetDec plugin for IDA (Interactive Disassembler).
The plugin is compatible with the IDA 7.x versions.
The plugin does NOT work with IDA 6.x, or freeware version of IDA 7.0.
The plugin comes at both 32-bit and 64-bit address space variants (both are 64-bit binaries). I.e. it works in both `ida` and `ida64`.
However, it can decompile only 32-bit binaries at the moment.
At the moment, it can decompile the following architectures:
* 32-bit: Intel x86, ARM, MIPS, PIC32, and PowerPC.
* 64-bit: x86-64.

## Installation and Use

Currently, we officially support only Windows and Linux. It may be possible to build macOS version from the sources, but since we do not own a macOS version of IDA, we cannot create a pre-built package, or continually make sure the macOS build is not broken.

### Windows

1. Either download and unpack a pre-built package from the following list, or build and install the RetDec IDA plugin by yourself (the process is described below):

* [Windows - for 64-bit IDA](https://github.com/avast-tl/retdec-idaplugin/releases/download/v0.8/retdec-idaplugin-v0.8-windows.zip) (v0.8)

2. Follow the user guide (`user_guide.pdf`) that is part of the downloaded package, or use the [current version](https://github.com/avast-tl/retdec-idaplugin/blob/master/doc/user_guide/user_guide.pdf) from this repository.

### Linux

1. Either download and unpack a pre-built package from the following list, or build and install the RetDec IDA plugin by yourself (the process is described below):

* [Linux - for 64-bit IDA](https://github.com/avast-tl/retdec-idaplugin/releases/download/v0.8/retdec-idaplugin-v0.8-linux.zip) (v0.8)

1. Either download and unpack a pre-built package from the [latest release](https://github.com/avast-tl/retdec-idaplugin/releases/latest), or build and install the RetDec IDA plugin by yourself (the process is described below).
2. Follow the user guide (`user_guide.pdf`) that is part of the downloaded package, or use the [current version](https://github.com/avast-tl/retdec-idaplugin/blob/master/doc/user_guide/user_guide.pdf) from this repository.

## Build and Installation
Expand Down
8 changes: 6 additions & 2 deletions doc/user_guide/user_guide.tex
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,15 @@ \section{Installation}
It is also possible to build and install the plugin directly from sources. To do so, follow the \href{https://github.com/avast-tl/retdec-idaplugin#build-and-installation}{Build and Installation} instructions instead of this section.

\subsection{IDA}
The plugin is created using IDA SDK version 7.0. The plugin is compatible with the following IDA versions: 7.0, 7.1. The plugin does NOT work with IDA 6.x, or freeware version of IDA 7.0. The plugin comes at both 32-bit and 64-bit address space variants (both are 64-bit binaries). I.e. it works in both \texttt{ida} and \texttt{ida64}. However, it can decompile only 32-bit binaries at the moment.
The plugin is created using IDA SDK version 7.0. The plugin is compatible with the following IDA versions: 7.0, 7.1. The plugin does NOT work with IDA 6.x, or freeware version of IDA 7.0. The plugin comes at both 32-bit and 64-bit address space variants (both are 64-bit binaries). I.e. it works in both \texttt{ida} and \texttt{ida64}. At the moment, it can decompile the following architectures:
\begin{itemize}
\item 32-bit: Intel x86, ARM, MIPS, PIC32, and PowerPC.
\item 64-bit: x86-64.
\end{itemize}

\subsection{RetDec}
\label{sec:installation:retdec}
RetDec IDA plugin needs a standalone RetDec installation in order to perform decompilations. This particular RetDec IDA plugin release needs RetDec version 3.2. Follow \href{https://github.com/avast-tl/retdec/blob/34a2640d71c96628d48864f14a32bd9cb237ed2b/README.md#installation-and-use}{these instructions} to install it.
RetDec IDA plugin needs a standalone RetDec installation in order to perform decompilations. This particular RetDec IDA plugin release needs RetDec version 3.3. Follow \href{https://github.com/avast-tl/retdec/blob/v3.3/README.md#installation-and-use}{these instructions} to install it.

\subsection{Python}
\label{sec:installation:python}
Expand Down

0 comments on commit 0bec63c

Please sign in to comment.