Merge pull request #2 from microsoft/melvinwang/improve-docs

Fixes to go with 0.1.0 crates.io releases

Author: wmmc88

Cargo.toml

@@ -17,12 +17,12 @@ readme = "README.md"
 license = "MIT OR Apache-2.0"
 
 [workspace.dependencies]
-wdk = { path = "crates/wdk" }
-wdk-alloc = { path = "crates/wdk-alloc" }
-wdk-build = { path = "crates/wdk-build" }
-wdk-macros = { path = "crates/wdk-macros" }
-wdk-panic = { path = "crates/wdk-panic" }
-wdk-sys = { path = "crates/wdk-sys" }
+wdk = { path = "crates/wdk", version = "0.1.0" }
+wdk-alloc = { path = "crates/wdk-alloc", version = "0.1.0" }
+wdk-build = { path = "crates/wdk-build", version = "0.1.0" }
+wdk-macros = { path = "crates/wdk-macros", version = "0.1.0" }
+wdk-panic = { path = "crates/wdk-panic", version = "0.1.0" }
+wdk-sys = { path = "crates/wdk-sys", version = "0.1.0" }
 bindgen = "0.68.1"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"

README.md

@@ -1,7 +1,7 @@
 # windows-drivers-rs
 
 
-This repo is a collection rust crates that enable developers to develop Windows Drivers in Rust. It is the intention to support both WDM and WDF driver development models. This repo contains the following crates:
+This repo is a collection of Rust crates that enable developers to develop Windows Drivers in Rust. It is the intention to support both WDM and WDF driver development models. This repo contains the following crates:
 
 * [wdk-build](./crates/wdk-build): A library to configure a Cargo build script for binding generation and downstream linking of the WDK (Windows Developer Kit). While this crate is written to be flexible with different WDK releases and different WDF version, it is currently only tested for NI eWDK, KMDF 1.33, UMDF 2.33, and WDM Drivers. There may be missing linker options for older DDKs.
 * [wdk-sys](./crates/wdk-sys): Direct FFI bindings to APIs available in the Windows Development Kit (WDK). This includes both autogenerated ffi bindings from `bindgen`, and also manual re-implementations of macros that bindgen fails to generate.
@@ -16,7 +16,7 @@ Note: This project is still in early stages of development and is not yet recomm
 
 ## <a name="supported-configs">Supported Configurations
 
-This project was built with support of WDM, KMDF, and UMDF drivers in mind, as well as Win32 Services. This includes support for all versions of WDF included in WDK 22H2 and newer. Currently, the crates available on [`crates.io`](crates.io) only support KMDF v1.33, but bindings can be generated for everything else by cloning `windows-drivers-rs` and modifying the config specified in [`build.rs` of `wdk-sys`](./crates/wdk-sys/build.rs). Crates.io support for other WDK configurations is planned in the near future.
+This project was built with support of WDM, KMDF, and UMDF drivers in mind, as well as Win32 Services. This includes support for all versions of WDF included in WDK 22H2 and newer. Currently, the crates available on [`crates.io`](https://crates.io) only support KMDF v1.33, but bindings can be generated for everything else by cloning `windows-drivers-rs` and modifying the config specified in [`build.rs` of `wdk-sys`](./crates/wdk-sys/build.rs). Crates.io support for other WDK configurations is planned in the near future.
 
 ## Getting Started
 
@@ -31,7 +31,7 @@ This project was built with support of WDM, KMDF, and UMDF drivers in mind, as w
 
 ## Adding windows-drivers-rs to Your Driver Package
 
-The crates in this repository are available from [`crates.io`](crates.io), but take into not the current limitations outlined in [Supported Configurations](#supported-configs). If you need to support a different config, try cloning this repo and using [path dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies)
+The crates in this repository are available from [`crates.io`](https://crates.io), but take into account the current limitations outlined in [Supported Configurations](#supported-configs). If you need to support a different config, try cloning this repo and using [path dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies)
 
 1. Create a new Cargo package with a lib crate:
 
@@ -130,7 +130,7 @@ The crates in this repository are available from [`crates.io`](crates.io), but t
    load_script = """
    pwsh.exe -Command "\
    if ($env:CARGO_MAKE_CRATE_IS_WORKSPACE) { return };\
-   $cargoMakeURI = ' https://raw.githubusercontent.com/microsoft/windows-drivers-rs/master/rust-driver-makefile.toml;\
+   $cargoMakeURI = 'https://raw.githubusercontent.com/microsoft/windows-drivers-rs/main/rust-driver-makefile.toml';\
    New-Item -ItemType Directory .cargo-make-loadscripts -Force;\
    Invoke-RestMethod -Method GET -Uri $CargoMakeURI -OutFile $env:CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY/.cargo-make-loadscripts/rust-driver-makefile.toml\
    "

crates/wdk-macros/Cargo.toml

@@ -7,7 +7,7 @@ description = "A collection of macros that help make it easier to interact with
 repository = "https://github.com/microsoft/windows-drivers-rs"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
-keywords = ["wdk", "windows", "wdf", "wdm", "ffi", "winapi"]
+keywords = ["wdk", "windows", "wdf", "wdm", "ffi"]
 categories = [
   "external-ffi-bindings",
   "development-tools::ffi",

crates/wdk-sys/Cargo.toml

@@ -8,7 +8,7 @@ description = "Direct bindings to APIs available in the Windows Development Kit
 repository.workspace = true
 readme.workspace = true
 license.workspace = true
-keywords = ["wdk", "windows", "wdf", "wdm", "ffi", "winapi"]
+keywords = ["wdk", "windows", "wdf", "wdm", "ffi"]
 categories = [
   "external-ffi-bindings",
   "development-tools::ffi",

crates/wdk/Cargo.toml

@@ -8,7 +8,7 @@ description = "Safe idiomatic bindings to APIs available in the Windows Developm
 repository.workspace = true
 readme.workspace = true
 license.workspace = true
-keywords = ["wdk", "windows", "wdf", "wdm", "ffi", "winapi"]
+keywords = ["wdk", "windows", "wdf", "wdm", "ffi"]
 categories = [
   "api-bindings",
   "development-tools::build-utils",