blob: 44c8179cf82ca7adf283e8e0a0188691d9322ff1 [file] [log] [blame]
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +08001Capstone source is organized as followings.
2
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +08003
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +08004. <- core engine + README + COMPILE.TXT etc
Nguyen Anh Quynhbdbde1f2013-11-27 17:00:06 +08005├── arch <- code handling disasm engine for each arch
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +08006│   ├── AArch64 <- ARM64 (aka ARMv8) engine
7│   ├── ARM <- ARM engine
8│   ├── Mips <- Mips engine
Nguyen Anh Quynhab26cd92014-01-07 11:46:21 +08009│   ├── PowerPC <- PowerPC engine
Nguyen Anh Quynh636f5062014-03-23 22:24:28 +080010│   ├── Sparc <- Sparc engine
11│   ├── SystemZ <- SystemZ engine
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +080012│   ├── X86 <- X86 engine
13│   └── XCore <- XCore engine
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080014├── bindings <- all bindings are under this dir
Nguyen Anh Quynhbdbde1f2013-11-27 17:00:06 +080015│   ├── java <- Java bindings + test code
16│   ├── ocaml <- Ocaml bindings + test code
pancake5ea50372014-11-01 22:14:13 +010017│   └── python <- Python bindings + test code
Nguyen Anh Quynhea980bd2014-11-02 00:34:14 +080018├── contrib <- Code contributed by community to help Capstone integration
19├── docs <- Documentation
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080020├── include <- API headers in C language (*.h)
Nguyen Anh Quynhea980bd2014-11-02 00:34:14 +080021├── msvc <- Microsoft Visual Studio support (for Windows compile)
22├── packages <- Packages for Linux/OSX/BSD.
Nguyen Anh Quynh6adc5c12014-01-07 11:34:05 +080023├── suite <- Development test tools - for Capstone developers only
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080024├── tests <- Test code (in C language)
pancake5ea50372014-11-01 22:14:13 +010025└── xcode <- Xcode support (for MacOSX compile)
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080026
27
Nguyen Anh Quynhea980bd2014-11-02 00:34:14 +080028Follow instructions in COMPILE.TXT for how to compile and run test code.
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080029
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080030Note: if you find some strange bugs, it is recommended to firstly clean
31the code and try to recompile/reinstall again. This can be done with:
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080032
Nguyen Anh Quynh06aef6b2014-05-07 16:00:33 +080033 $ ./make.sh
34 $ sudo ./make.sh install
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080035
Nguyen Anh Quynhea980bd2014-11-02 00:34:14 +080036At the same time, for Java/Ocaml/Python bindings, be sure to always use
37the bindings coming with the core to avoid potential incompatility issue
38with older versions.
39See bindings/<language>/README for detail instructions on how to compile &
40install the bindings.