aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index d8361cf..a6b49cf 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
# Windows Kernel-Mode Drivers written in Rust
+This library is just a proof-of-concept of windows kernel-mode drivers, which can be written in Rust programming language.
+
+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).
+
+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 Kernel-Mode Drivers: [kmd-env-rs](https://github.com/pravic/kmd-env-rs)
+
+TBD.