Skip to content

Commit 043ec19

Browse files
committed
Adapt documentation with the new building mode
1 parent 57adb17 commit 043ec19

2 files changed

Lines changed: 56 additions & 4 deletions

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,16 @@ ls = quokka.Program("ls.quokka", # the exported file
101101

102102
## Building
103103

104-
### Build
104+
The process for building depends on which version of the IDA SDK you are using.
105+
These two modes are also referred as *the new mode* and *the old mode*.
106+
107+
### IDA < 9.2 (The old way)
108+
109+
Since the IDA SDK is still proprietary code, you have to fetch it yourself and provide
110+
its path to cmake through the option `-DIdaSdk_ROOT_DIR:STRING=path/to/sdk`
111+
112+
**NOTE:** This will also work on newer versions but it requires more steps from
113+
the users as they will have to download the sdk themselves.
105114

106115
```console
107116
user@host:~/quokka$ cmake -B build \ # Where to build
@@ -112,6 +121,24 @@ user@host:~/quokka$ cmake -B build \ # Where to build
112121
user@host:~/quokka$ cmake --build build --target quokka_plugin -- -j
113122
```
114123

124+
### IDA >= 9.2 (The new way)
125+
126+
Ida SDK has been finally [open sourced](https://github.com/HexRaysSA/ida-sdk) so there is no need
127+
anymore to download it separately.
128+
129+
You can use the cmake option `-DIDA_VERSION=<major>.<minor>` to automatically sync it from github.
130+
131+
```console
132+
user@host:~/quokka$ cmake -B build \ # Where to build
133+
-S . \ # Where are the sources
134+
-DIDA_VERSION=9.2 \ # IDA SDK version
135+
-DCMAKE_BUILD_TYPE:STRING=Release \ # Build Type
136+
137+
user@host:~/quokka$ cmake --build build --target quokka_plugin -- -j
138+
```
139+
140+
### Install
141+
115142
To install the plugin:
116143

117144
```console

docs/installation.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,40 @@ The first step is to download the sources. You can clone the repository like in
8383

8484

8585
To 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+
95120
If the first step succeeded, you can now do the actual building.
96121

97122
```console

0 commit comments

Comments
 (0)