| Nguyen Anh Quynh | 1ae38db | 2013-11-27 14:33:13 +0800 | [diff] [blame] | 1 | Capstone source is organized as followings. |
| 2 | |
| Nguyen Anh Quynh | 7f36d26 | 2013-12-05 10:25:51 +0800 | [diff] [blame] | 3 | |
| Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 4 | . <- core engine + README + COMPILE.TXT etc |
| Nguyen Anh Quynh | bdbde1f | 2013-11-27 17:00:06 +0800 | [diff] [blame] | 5 | ├── arch <- code handling disasm engine for each arch |
| Nguyen Anh Quynh | 7f36d26 | 2013-12-05 10:25:51 +0800 | [diff] [blame] | 6 | │ ├── AArch64 <- ARM64 (aka ARMv8) engine |
| 7 | │ ├── ARM <- ARM engine |
| 8 | │ ├── Mips <- Mips engine |
| Nguyen Anh Quynh | ab26cd9 | 2014-01-07 11:46:21 +0800 | [diff] [blame] | 9 | │ ├── PowerPC <- PowerPC engine |
| Nguyen Anh Quynh | 636f506 | 2014-03-23 22:24:28 +0800 | [diff] [blame] | 10 | │ ├── Sparc <- Sparc engine |
| 11 | │ ├── SystemZ <- SystemZ engine |
| Nguyen Anh Quynh | c80d840 | 2014-05-26 23:02:48 +0800 | [diff] [blame] | 12 | │ ├── X86 <- X86 engine |
| 13 | │ └── XCore <- XCore engine |
| Nguyen Anh Quynh | 18ebd80 | 2013-11-27 21:29:12 +0800 | [diff] [blame] | 14 | ├── bindings <- all bindings are under this dir |
| Nguyen Anh Quynh | bdbde1f | 2013-11-27 17:00:06 +0800 | [diff] [blame] | 15 | │ ├── java <- Java bindings + test code |
| 16 | │ ├── ocaml <- Ocaml bindings + test code |
| pancake | 5ea5037 | 2014-11-01 22:14:13 +0100 | [diff] [blame] | 17 | │ └── python <- Python bindings + test code |
| Nguyen Anh Quynh | ea980bd | 2014-11-02 00:34:14 +0800 | [diff] [blame] | 18 | ├── contrib <- Code contributed by community to help Capstone integration |
| 19 | ├── docs <- Documentation |
| Nguyen Anh Quynh | 7f36d26 | 2013-12-05 10:25:51 +0800 | [diff] [blame] | 20 | ├── include <- API headers in C language (*.h) |
| Nguyen Anh Quynh | ea980bd | 2014-11-02 00:34:14 +0800 | [diff] [blame] | 21 | ├── msvc <- Microsoft Visual Studio support (for Windows compile) |
| 22 | ├── packages <- Packages for Linux/OSX/BSD. |
| tandasat | 59df550 | 2016-05-14 16:04:28 -0700 | [diff] [blame^] | 23 | ├── windows <- Windows support (for Windows kernel driver compile) |
| Nguyen Anh Quynh | 6adc5c1 | 2014-01-07 11:34:05 +0800 | [diff] [blame] | 24 | ├── suite <- Development test tools - for Capstone developers only |
| Nguyen Anh Quynh | 7f36d26 | 2013-12-05 10:25:51 +0800 | [diff] [blame] | 25 | ├── tests <- Test code (in C language) |
| pancake | 5ea5037 | 2014-11-01 22:14:13 +0100 | [diff] [blame] | 26 | └── xcode <- Xcode support (for MacOSX compile) |
| Nguyen Anh Quynh | 1ae38db | 2013-11-27 14:33:13 +0800 | [diff] [blame] | 27 | |
| 28 | |
| Nguyen Anh Quynh | ea980bd | 2014-11-02 00:34:14 +0800 | [diff] [blame] | 29 | Follow instructions in COMPILE.TXT for how to compile and run test code. |
| Nguyen Anh Quynh | 18ebd80 | 2013-11-27 21:29:12 +0800 | [diff] [blame] | 30 | |
| Nguyen Anh Quynh | 7f36d26 | 2013-12-05 10:25:51 +0800 | [diff] [blame] | 31 | Note: if you find some strange bugs, it is recommended to firstly clean |
| 32 | the code and try to recompile/reinstall again. This can be done with: |
| Nguyen Anh Quynh | 1ae38db | 2013-11-27 14:33:13 +0800 | [diff] [blame] | 33 | |
| Nguyen Anh Quynh | 06aef6b | 2014-05-07 16:00:33 +0800 | [diff] [blame] | 34 | $ ./make.sh |
| 35 | $ sudo ./make.sh install |
| Nguyen Anh Quynh | 1ae38db | 2013-11-27 14:33:13 +0800 | [diff] [blame] | 36 | |
| Nguyen Anh Quynh | ea980bd | 2014-11-02 00:34:14 +0800 | [diff] [blame] | 37 | At the same time, for Java/Ocaml/Python bindings, be sure to always use |
| 38 | the bindings coming with the core to avoid potential incompatility issue |
| 39 | with older versions. |
| 40 | See bindings/<language>/README for detail instructions on how to compile & |
| 41 | install the bindings. |