x64dbg
/
zydis
mirror of https://github.com/x64dbg/zydis
1
0
Fork 0
Code Releases Activity

Updated README.md

This commit is contained in:
Joel Höner 2017-07-24 22:41:08 +02:00
parent 6de4794814
commit a50b9cd83c
1 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -18,6 +18,14 @@ Fast and lightweight x86/x86-64 disassembler library.
- Very small file-size overhead compared to other common disassembler libraries - Very small file-size overhead compared to other common disassembler libraries
- Complete doxygen documentation - Complete doxygen documentation
## Roadmap ##
- Language bindings [v2.0 final]
- Tests [v2.0 final]
- Graphical editor for the instruction-database [v2.0 final]
- Implement CMake feature gates. Currently, everything is always included. [v2.0 final]
- Encoding support [v2.1]
## Quick Example ## ## Quick Example ##
The following example program uses Zydis to disassemble a given memory buffer and prints the output to the console. The following example program uses Zydis to disassemble a given memory buffer and prints the output to the console.
@ -60,6 +68,19 @@ int main()
} }
``` ```
## Compilation ##
Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C99 compiler.
```bash
# Linux and OS X
git clone 'https://github.com/zyantific/zydis.git'
cd zydis
mkdir build && cd build
cmake ..
make
```
## Sample Output ## ## Sample Output ##
The above example program generates the following output: The above example program generates the following output:
@ -75,17 +96,9 @@ The above example program generates the following output:
007FFFFFFF400013 js 0x007FFFFFFF42DB15 007FFFFFFF400013 js 0x007FFFFFFF42DB15
``` ```
## Compilation ## ## ZydisInfo tool ##
![ZydisInfo](https://raw.githubusercontent.com/zyantific/zydis/master/assets/screenshots/ZydisInfo.png)
Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C99 compiler.
## Roadmap ##
- Language bindings
- Tests
- Encoding support
- Graphical editor for the instruction-database
## License ## ## License ##
Zyan Disassembler Engine is licensed under the MIT License. Dependencies are under their respective licenses. Zydis is licensed under the MIT license.