README.md
1Capstone Engine
2===============
3
4[](https://travis-ci.org/aquynh/capstone)
5[](https://ci.appveyor.com/project/aquynh/capstone/branch/master)
6[](https://pypi.python.org/pypi/capstone)
7[](https://pepy.tech/project/capstone)
8
9Capstone is a disassembly framework with the target of becoming the ultimate
10disasm engine for binary analysis and reversing in the security community.
11
12Created by Nguyen Anh Quynh, then developed and maintained by a small community,
13Capstone offers some unparalleled features:
14
15- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K,
16 Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86 (including X86_64).
17
18- Having clean/simple/lightweight/intuitive architecture-neutral API.
19
20- Provide details on disassembled instruction (called “decomposer” by others).
21
22- Provide semantics of the disassembled instruction, such as list of implicit
23 registers read & written.
24
25- Implemented in pure C language, with lightweight bindings for D, Clojure, F#,
26 Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python,
27 Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
28 (ready either in main code, or provided externally by the community).
29
30- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
31 Linux, \*BSD, Solaris, etc.
32
33- Thread-safe by design.
34
35- Special support for embedding into firmware or OS kernel.
36
37- High performance & suitable for malware analysis (capable of handling various
38 X86 malware tricks).
39
40- Distributed under the open source BSD license.
41
42Further information is available at http://www.capstone-engine.org
43
44
45Compile
46-------
47
48See COMPILE.TXT file for how to compile and install Capstone.
49
50
51Documentation
52-------------
53
54See docs/README for how to customize & program your own tools with Capstone.
55
56
57Hack
58----
59
60See HACK.TXT file for the structure of the source code.
61
62
63License
64-------
65
66This project is released under the BSD license. If you redistribute the binary
67or source code of Capstone, please attach file LICENSE.TXT with your products.
68
){kind=link}
){kind=link}