From 818ded7eefa828506313028f2301121e1288a29a Mon Sep 17 00:00:00 2001 From: flobernd Date: Thu, 30 Nov 2017 22:50:33 +0100 Subject: [PATCH] Converted MSVC README to markdown --- msvc/{README.txt => README.md} | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) rename msvc/{README.txt => README.md} (73%) diff --git a/msvc/README.txt b/msvc/README.md similarity index 73% rename from msvc/README.txt rename to msvc/README.md index 1078bec..8207fb0 100644 --- a/msvc/README.txt +++ b/msvc/README.md @@ -1,3 +1,5 @@ +## Readme + This directory contains MSVC project files to build Zydis and the included tools and examples. There are three build configurations, each with 32/64 bit and debug/release versions: @@ -6,8 +8,8 @@ There are three build configurations, each with 32/64 bit and debug/release vers - Kernel mode In order to build the kernel mode configuration you must have the Microsoft WDK installed, available at https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit. -The kernel mode configuration only builds Zydis and the ZydisWinKernel driver sample. The other configurations build all projects except for ZydisWinKernel. +The kernel mode configuration only builds `Zydis` and the `ZydisWinKernel` driver sample. The other configurations build all projects except for `ZydisWinKernel`. NOTE: If you already have the WDK installed, make sure it is updated to at least the Windows 10 1709 version (10.0.16299.0) in order to prevent issues opening the solution file. This is due to a bug in older WDK toolsets. -All Zydis features are enabled by default. In order to disable specific features you can define preprocessor directives such as ZYDIS_DISABLE_FORMATTER. Refer to CMakeLists.txt for the full list of feature switches. +All Zydis features are enabled by default. In order to disable specific features you can define preprocessor directives such as `ZYDIS_DISABLE_FORMATTER`. Refer to `CMakeLists.txt` for the full list of feature switches.