@@ -83,15 +83,40 @@ The first step is to download the sources. You can clone the repository like in
8383
8484
8585To compile ` quokka ` , you first need to generate the configuration using ` CMake ` .
86+ The process for building depends on which version of the IDA SDK you are using.
87+ These two modes are also referred as * the new mode* and * the old mode* .
88+
89+ ##### IDA < 9.2 (The old way)
90+
91+ Since the IDA SDK is still proprietary code, you have to fetch it yourself and provide
92+ its path to cmake through the option ` -DIdaSdk_ROOT_DIR:STRING=path/to/sdk `
93+
94+ ** NOTE:** This will also work on newer versions but it requires more steps from
95+ the users as they will have to download the sdk themselves.
96+
97+ ``` console
98+ user@host:~/quokka $ cmake -B build \ # Where to build
99+ -S . \ # Where are the sources
100+ -DIdaSdk_ROOT_DIR:STRING=path/to/ida_sdk \ # Path to IDA SDK
101+ -DCMAKE_BUILD_TYPE:STRING=Release # Build Type
102+ ```
103+
104+ ### IDA >= 9.2 (The new way)
105+
106+ Ida SDK has been finally [ open sourced] ( https://github.com/HexRaysSA/ida-sdk ) so there is no need
107+ anymore to download it separately.
108+
109+ You can use the cmake option ` -DIDA_VERSION=<major>.<minor> ` to automatically sync it from github.
86110
87111``` console
88- user@host:~ $ cd quokka
89- user@host:~/quokka $ cmake -B build \ # Where to build
112+ user@host:~/quokka $ cmake -B build \ # Where to build
90113 -S . \ # Where are the sources
91- -DIdaSdk_ROOT_DIR:STRING=path/to/ida_sdk \ # Path to IDA SDK
114+ -DIDA_VERSION=9.2 \ # IDA SDK version
92115 -DCMAKE_BUILD_TYPE:STRING=Release # Build Type
93116```
94117
118+ ##### Finalize the build
119+
95120If the first step succeeded, you can now do the actual building.
96121
97122``` console
0 commit comments