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