blob: 2462169df10ead79c3671923d32ac27bae21e91b [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 Quynh7f36d262013-12-05 10:25:51 +080010│   └── X86 <- X86 engine
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080011├── bindings <- all bindings are under this dir
Nguyen Anh Quynhbdbde1f2013-11-27 17:00:06 +080012│   ├── java <- Java bindings + test code
13│   ├── ocaml <- Ocaml bindings + test code
14│   ├── python <- Python bindings + test code
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080015├── include <- API headers in C language (*.h)
Nguyen Anh Quynh6adc5c12014-01-07 11:34:05 +080016├── suite <- Development test tools - for Capstone developers only
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080017├── tests <- Test code (in C language)
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080018
19
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +080020Follow instructions in COMPILE.TXT to see how to compile and run code.
Nguyen Anh Quynh18ebd802013-11-27 21:29:12 +080021
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080022Note: if you find some strange bugs, it is recommended to firstly clean
23the code and try to recompile/reinstall again. This can be done with:
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080024
25 $ make clean
26 $ make
Nguyen Anh Quynh7f36d262013-12-05 10:25:51 +080027 $ sudo make install
Nguyen Anh Quynh1ae38db2013-11-27 14:33:13 +080028
29