keystone-engine-keystone/docs/COMPILE-NIX.md at 25ff3f3cef24d5ac855a94cedb28e446c49f5a8d

mirror of https://github.com/keystone-engine/keystone synced 2026-06-08 15:15:30 +00:00

Files

T

Nguyen Anh Quynh e366688f8c better readability for docs/COMPILE*

2016-04-28 21:24:02 +08:00

This documentation explains how to build & install Keystone on all kind of nix OS. For Windows, see COMPILE-WINDOWS.md

CMake is required as dependency.

On Mac OS X, you can install "cmake" with "brew".
```
  $ brew install cmake
```
On Utunbu Linux, install "cmake" with.
```
  $ sudo apt-get install cmake
```

From the root directory of Keystone source, compile dynamic library with below commands.
```
 $ mkdir build
 $ cd build
 $ ../make-share.sh
```
You can also compile static libray with.
```
 $ mkdir build
 $ cd build
 $ ../make-lib.sh
```
Right after building step, install Keystone.
```
 $ sudo make install
```
Besides the libraries & C header files under directory "include/keystone", this step also installs a tool named "kstool" into the system. (Find source of "kstool" in directory "kstool/kstool")
Test Keystone with "kstool" like below.
```
 $ kstool x32 "add eax, ebx"
```
Run "kstool" without any option to find out how to use this handy tool.
Learn more on how to code your own tools with our samples.

For C sample code, see code in directory samples/

For Python sample code, see code in directory bindings/python/