From a50b9cd83c6955f5d3d71b81c65fc1cd083beb0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joel=20H=C3=B6ner?= Date: Mon, 24 Jul 2017 22:41:08 +0200 Subject: [PATCH] Updated README.md --- README.md | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e0e2968..48f6214 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,14 @@ Fast and lightweight x86/x86-64 disassembler library. - Very small file-size overhead compared to other common disassembler libraries - 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 ## 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 ## The above example program generates the following output: @@ -75,17 +96,9 @@ The above example program generates the following output: 007FFFFFFF400013 js 0x007FFFFFFF42DB15 ``` -## Compilation ## - -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 +## ZydisInfo tool ## +![ZydisInfo](https://raw.githubusercontent.com/zyantific/zydis/master/assets/screenshots/ZydisInfo.png) ## License ## -Zyan Disassembler Engine is licensed under the MIT License. Dependencies are under their respective licenses. +Zydis is licensed under the MIT license. \ No newline at end of file