From 3e5152bf9b5c6ed712d7a9a831456bd0938efed2 Mon Sep 17 00:00:00 2001 From: pravic Date: Tue, 12 Apr 2016 21:51:21 +0300 Subject: add getting started guide --- README.md | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5f795e4..58075fb 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,43 @@ This library is just a proof-of-concept of windows kernel-mode drivers, which ca It contains the types, constants and bindings for the [Windows Driver Kit](https://en.wikipedia.org/wiki/Windows_Driver_Kit) with target OS starting from Windows XP (x86/x64). + +### Getting started + To compile you need the following: * Nightly Rust with MSVC ABI starting from 2016-04-12 (?), which supports "[is-like-msvc](https://github.com/rust-lang/rust/pull/32823)" target flavor. * MSVC itself, either VS 2015 or just MSVC Build Tools. -* Rust environment for the Windows drivers: [kmd-env-rs](https://github.com/pravic/kmd-env-rs) +* Rust environment for the Windows drivers: [kmd-env-rs](https://github.com/pravic/kmd-env-rs). + +Setting up: + +``` +git clone https://github.com/pravic/kmd-env-rs . +git submodule init +git submodule update --recursive +``` + +Set the nightly-msvc Rust toolchain [for this](https://github.com/rust-lang-nursery/multirust-rs#directory-overrides) repository: + +`rustup override add nightly-i686-msvc` + +Try to compile example: + +``` +cd km\examples\01.minimal\ +cargo build --release +``` -TBD. ### Examples -[Here](https://github.com/pravic/winapi-km-rs/tree/master/examples) is a three basic driver samples. +See [examples](https://github.com/pravic/winapi-kmd-rs/tree/master/examples) folder with a driver samples and screenshots. + + +### [Reference documentation](http://pravic.github.io/winapi-kmd-rs/). + -## [Reference](http://pravic.github.io/winapi-km-rs/) +#### Acknowledges +In memory of [Four-F](http://four-f.narod.ru/) - the author of tutorials about kernel mode drivers development in assembly language (2002-2005). -- cgit v1.2.3