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
9Deprecation
10===========
11
12The [`master`](https://github.com/capstone-engine/capstone/tree/master) branch is deprecated.
13All forward development should be based on the [`next`](https://github.com/capstone-engine/capstone/tree/next) branch.
14
15To clone a fresh checkout with the `next` branch:
16
17 git clone -b next https://github.com/capstone-engine/capstone
18
19To change to the `next` branch in an existing checkout:
20
21 git checkout next
22
23----
24
25We moved the original historical repo of Capstone from https://github.com/aquynh/capstone to an organization, where we can add more maintainers to the project, and push Capstone development forward.
26
27Our new home is https://github.com/capstone-engine/capstone
28
29Nov 8th, 2021.
30
31----
32
33Capstone is a disassembly framework with the target of becoming the ultimate
34disasm engine for binary analysis and reversing in the security community.
35
36Created by Nguyen Anh Quynh, then developed and maintained by a small community,
37Capstone offers some unparalleled features:
38
39- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K,
40 Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86 (including X86_64).
41
42- Having clean/simple/lightweight/intuitive architecture-neutral API.
43
44- Provide details on disassembled instruction (called “decomposer” by others).
45
46- Provide semantics of the disassembled instruction, such as list of implicit
47 registers read & written.
48
49- Implemented in pure C language, with lightweight bindings for D, Clojure, F#,
50 Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python,
51 Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
52 (ready either in main code, or provided externally by the community).
53
54- Native support for all popular platforms: Windows, macOS, iOS, Android,
55 Linux, \*BSD, Solaris, etc.
56
57- Thread-safe by design.
58
59- Special support for embedding into firmware or OS kernel.
60
61- High performance & suitable for malware analysis (capable of handling various
62 X86 malware tricks).
63
64- Distributed under the open source BSD license.
65
66Further information is available at http://www.capstone-engine.org
67
68
69Compile
70-------
71
72See COMPILE.TXT file for how to compile and install Capstone.
73
74
75Documentation
76-------------
77
78See docs/README for how to customize & program your own tools with Capstone.
79
80
81Hack
82----
83
84See HACK.TXT file for the structure of the source code.
85
86
87License
88-------
89
90This project is released under the BSD license. If you redistribute the binary
91or source code of Capstone, please attach file LICENSE.TXT with your products.
92
){kind=link}
){kind=link}