capstone

mirror of https://github.com/capstone-engine/capstone.git synced 2024-11-23 05:29:53 +00:00

History

Rot127 2cfca35e2f Some checks failed Run Test / ${{ matrix.config.name }} (map[arch:x64 build-system:cmake diet-build:OFF enable-asan:OFF name:ubuntu-22.04 x64 cmake os:ubuntu-22.04]) (push) Has been cancelled Details Run Test / ${{ matrix.config.name }} (map[arch:x64 build-system:cmake diet-build:OFF enable-asan:ON name:ubuntu-24.04 x64 ASAN os:ubuntu-24.04]) (push) Has been cancelled Details Run Test / ${{ matrix.config.name }} (map[arch:x64 build-system:make diet-build:OFF enable-asan:OFF name:ubuntu-22.04 x64 make os:ubuntu-22.04]) (push) Has been cancelled Details Run Test / ${{ matrix.config.name }} (map[arch:x64 name:windows x64 MSVC 64bit os:windows-latest platform:windows python-arch:x64 python-version:3.9]) (push) Has been cancelled Details Auto-Sync / check (push) Has been cancelled Details Run clang-tidy / clang-tidy (push) Has been cancelled Details RELEASE BUILD - PyPI 📦 Distribution / Build wheels on ${{ matrix.os }} (macos-latest) (push) Has been cancelled Details RELEASE BUILD - PyPI 📦 Distribution / Build wheels on ${{ matrix.os }} (ubuntu-latest) (push) Has been cancelled Details RELEASE BUILD - PyPI 📦 Distribution / Build wheels on ${{ matrix.os }} (windows-latest) (push) Has been cancelled Details RELEASE BUILD - PyPI 📦 Distribution / Make SDist (push) Has been cancelled Details Python Package CI / build (macOS-14, 3.12) (push) Has been cancelled Details Python Package CI / build (macOS-14, 3.8) (push) Has been cancelled Details Python Package CI / build (ubuntu-24.04, 3.12) (push) Has been cancelled Details Python Package CI / build (ubuntu-24.04, 3.8) (push) Has been cancelled Details Python Package CI / build (windows-2022, 3.12) (push) Has been cancelled Details Python Package CI / build (windows-2022, 3.8) (push) Has been cancelled Details RELEASE BUILD - PyPI 📦 Distribution / publish (push) Has been cancelled Details Coverity Scan / latest (push) Has been cancelled Details Add CC and VAS compatibility macros (#2525 )		2024-10-25 21:38:33 +08:00
..
ARCHITECTURE.md	Architecture updater (auto-sync) - Updating PPC (#2013 )	2023-09-05 12:24:59 +08:00
BHUSA2014-capstone.pdf	move slides to docs/	2014-08-15 14:08:20 +08:00
capstone-logo.png	add docs/capstone-logo.png	2018-12-31 16:29:00 +08:00
cs_v6_release_guide.md	Add CC and VAS compatibility macros (#2525 )	2024-10-25 21:38:33 +08:00
README	Update README (#1534 )	2019-08-30 23:39:52 +08:00

README

Documentation of Capstone disassembly framework.

* Switching to 2.1 engine.

	http://capstone-engine.org/version_2.1_API.html

* How to compile & install Capstone.

	http://capstone-engine.org/documentation.html

* Programming with C language.

	http://capstone-engine.org/lang_c.html

* Programming with Python language.

	http://capstone-engine.org/lang_python.html

* Programming with Java language.

	http://capstone-engine.org/lang_java.html

* Customize instruction mnemonics at run-time.

	http://capstone-engine.org/mnemonic.html

* Retrieve access information of instruction operands.

	http://capstone-engine.org/op_access.html

* Build compact engine with only selected architectures.

	http://capstone-engine.org/compile.html

* Build "diet" engine for even smaller libraries.

	http://capstone-engine.org/diet.html

* Build embedded engine for firmware/OS kernel.

	http://capstone-engine.org/embed.html

* SKIPDATA mode to keep disassembling after hitting a broken instruction.

	http://capstone-engine.org/skipdata.html

* Quickly iterate instructions with cs_disasm_iter().

	http://capstone-engine.org/iteration.html

* Build X86-reduce engine for firmware/OS kernel.

	http://capstone-engine.org/x86reduce.html

* Sample applications on how to embed Capstone into Windows kernel driver.

	https://github.com/aquynh/capstone/tree/master/contrib/cs_driver (in C, basic)
	https://github.com/aquynh/KernelProject (in C++)

* Sample application on how to embed Capstone into Mac OSX Kext (kernel).

	https://github.com/aquynh/CapstoneTest
	
* A Micro Capstone-Engine API Documentation in Chinese

        https://github.com/kabeor/Micro-Capstone-Engine-API-Documentation/blob/master/Micro%20Capstone-Engine%20API%20Documentation.md