Skip to content

Commit 5a48d2c

Browse files
committed
Updated README
1 parent 88bce8e commit 5a48d2c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ using (var disassembler = CapstoneDisassembler.CreateX86Disassembler(Disassemble
9090

9191
(+) **Capstone 3 (X86)**: Capstone.NET is compatible **only** with the X86 version of Capstone 3. Please make sure you only use that version before you open an issue. Down the road, I will definitely have support for the X64 version of Capstone. If this is a problem for you, feel free to either open an issue or fork the project and make it compatible with both X86 and X64. Significant changes might be required to deal with structure alignment issues when interfacing with the native Capstone API.
9292

93-
(+) **X86 Compiled Binary**: Capstone.NET is compiled as an X86 DLL. This, obviously, means you should only reference it from a X86 binary. The word **should** should be taken with a grain of salt here because the C# compiler will only trigger a warning if you reference it from an X64 binary but please be aware that Capstone.NET has **not** been tested when referenced from an X64 binary so possible runtime exceptions or errors might occur. If this is a problem for you, feel free to either open an issue or fork the project and make it compatible with both X86 and X64. Significant changes might be required to deal with structure alignment issues when interfacing with the native Capstone API.
93+
(+) **X86 Compiled Assembly**: Capstone.NET is compiled as an X86 DLL. This, obviously, means you should only reference it from an X86 assembly. The word **should** should be taken with a grain of salt here because the C# compiler will only trigger a warning if you reference it from an X64 assembly but please be aware that Capstone.NET has **not** been tested when referenced from an X64 binary so possible runtime exceptions or errors might occur. If this is a problem for you, feel free to either open an issue or fork the project and make it compatible with both X86 and X64. Significant changes might be required to deal with structure alignment issues when interfacing with the native Capstone API.
9494

95-
(+) *Unsafe Binary (Optional)*: Deep under the hood, some Capstone.NET APIs use unsafe code when interfacing with the native Capstone API. These APIs are abstracted away from you behind the object oriented (OO) API that is recommended you use when using Capstone.NET in your application or library. However, **if**, and only **if**, you want to use these unsafe APIs in your code, you **must** compile your binary with the C# compiler switch */unsafe*. Just to make sure this is clear, you **only** need to compile your binary with the */unsafe* switch if you use any unsafe APIs **directly** from your code. Otherwise you are fine and you do not need to use this switch. See MSDN for more information.
95+
(+) *Unsafe Assembly (Optional)*: Deep under the hood, some Capstone.NET APIs use unsafe code when interfacing with the native Capstone API. These APIs are abstracted away from you behind the scenes. However, **if**, and only **if**, you want to use these unsafe APIs in your code, you **must** compile your assembly with the C# compiler switch */unsafe*. Just to make sure this is clear, you **only** need to compile your assembly with the */unsafe* switch if you use any unsafe APIs **directly** from your code. Otherwise you are fine and you do not need to use this switch. See MSDN for more information.
9696

9797
## Packaged Installation
9898
The simplest way to get started with Capstone.NET is to download the latest release package. It will contain all the compiled binaries you need to get started. The latest release will usually be backwards compatible with older releases but as both Capstone.NET and Capstone mature, this might not always be the case. Please make sure to read the release notes for each release before upgrading!

0 commit comments

Comments
 (0)