1To install Capstone, you should run `pip install capstone`.
2
3If you would like to build Capstone with just the source distribution, without
4pip, just run `python setup.py install` in the folder with setup.py in it.
5
6In order to use this source distribution, you will need an environment that can
7compile C code. On Linux, this is usually easy, but on Windows, this involves
8installing Visual Studio and using the "Developer Command Prompt" to perform the
9installation. See BUILDING.txt for more information.
10
11By default, attempting to install the python bindings will trigger a build of
12the capstone native core. If this is undesirable for whatever reason, for
13instance, you already have a globally installed copy of libcapstone, you may
14inhibit the build by setting the environment variable LIBCAPSTONE_PATH. The
15exact value is not checked, just setting it will inhibit the build. During
16execution, this variable may be set to the path of a directory containing a
17specific version of libcapstone you would like to use.
18
19If you don't want to build your own copy of Capstone, you can use a precompiled
20binary distribution from PyPI. Saying `pip install capstone` should
21automatically obtain an appropriate copy for your system. If it does not, please
22open an issue at https://github.com/aquynh/capstone and tag @rhelmot - she
23will fix this, probably!
24
25--------------------------------------------------------------------------------
26
27Capstone is a disassembly framework with the target of becoming the ultimate
28disasm engine for binary analysis and reversing in the security community.
29
30Created by Nguyen Anh Quynh, then developed and maintained by a small community,
31Capstone offers some unparalleled features:
32
33- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc,
34 SystemZ, XCore and X86 (including X86_64).
35
36- Having clean/simple/lightweight/intuitive architecture-neutral API.
37
38- Provide details on disassembled instruction (called “decomposer” by others).
39
40- Provide semantics of the disassembled instruction, such as list of implicit
41 registers read & written.
42
43- Implemented in pure C language, with lightweight wrappers for C++, C#, Go,
44 Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code,
45 or provided externally by the community).
46
47- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
48 Linux, *BSD, Solaris, etc.
49
50- Thread-safe by design.
51
52- Special support for embedding into firmware or OS kernel.
53
54- High performance & suitable for malware analysis (capable of handling various
55 X86 malware tricks).
56
57- Distributed under the open source BSD license.
58
59Further information is available at http://www.capstone-engine.org
60
61
62[License]
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