denuvo-ref/capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/capstone synced 2026-08-11 16:26:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
capstone/docs
History
Rot127 40dffb2668
Documentation updates (#2476) 
* Remove Windows msvc project files and move build instructions to single BUILDING.md file.

* Move HACK.txt to Contributing and update it.

* Add refactoring guide.

* Add known bugs

* Remove compatibility headers.

* Fix smaller issues.

* Remove 'possible revert' column. People always can do manual changes.

* Move instruction alias description to the top

* Add table to general breaking changes.

* Update general release guide with the newest information.

* Highlight NanoMips and be more precise in writing.

* Add note about archs without alias.

* Add sentence about what is planned.

* Small corrections for Windows build instructions and debug macros.

* Fix rebase issues.

* Bring back make.sh for the CI
2024-09-23 11:26:56 +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 Documentation updates (#2476) 2024-09-23 11:26:56 +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