blob: 923cf94bec196907f0b7ca500d7de3a71b3974b7 [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 Quynhbdbde1f2013-11-27 17:00:06 +08004. <- core engine + README + COMPILE etc
5├── 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
9│   └── X86 <- X86 engine
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080010├── bindings <- all bindings are under this dir
Nguyen Anh Quynhbdbde1f2013-11-27 17:00:06 +080011│   ├── csharp <- C# bindings + test code
12│   ├── java <- Java bindings + test code
13│   ├── ocaml <- Ocaml bindings + test code
14│   ├── python <- Python bindings + test code
15│   └── ruby <- Ruby bindings + test code
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080016├── include <- API headers in C language (*.h)
Nguyen Anh Quynhbdbde1f2013-11-27 17:00:06 +080017├── release <- Precompiled binaries
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080018│   ├── linux <- .deb, .rpm, python packages, etc
19│   ├── mac <- .dmg
20│   └── windows <- .msi, .exe, .dll, etc
Nguyen Anh Quynh6adc5c12014-01-07 11:34:05 +080021├── suite <- Development test tools - for Capstone developers only
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080022├── tests <- Test code (in C language)
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080023
24
25Follow COMPILE to see how to compile and run code.
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080026
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080027Note: if you find some strange bugs, it is recommended to firstly clean
28the code and try to recompile/reinstall again. This can be done with:
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080029
30 $ make clean
31 $ make
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080032 $ sudo make install
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080033
34