From 5f884dc7c955767f21b6c0523a365dec8dc89210 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20L=C3=B6hr?= Date: Tue, 1 Aug 2017 01:29:45 +0200 Subject: [PATCH] Update Readme --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index afeccaf..9658ed4 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,15 @@ http://julianloehr.de/educational-work/hid-wiimote/ To build the driver yourself you need the following software. All paths in the project are either relative or are using Visual Studio Macros. -The One-Click Build is open `Build` > `Batch Build...`, check only all `BuildAndZip` Configurations and hit `Build` or `Rebuild`. This will build all drivers, the installer, pack everything into a Driver Package and Zip it. The final Zips are then found in the `Zip` folder. +The One-Click Build is open `Build` > `Batch Build...`, check only all `BuildAndZip` Configurations and hit `Build` or `Rebuild`. This will build all drivers, User Mode app and library, pack everything into a Driver Package and Zip it. The final Zips are then found in the `Zip` folder. ### Requirements -* Visual Studio 2015 +* Visual Studio 2015 Update 3 +* Windows SDK for Windows 10 * Windows Driver Kit (WDK 10) -Both can be downloaded on this page: https://msdn.microsoft.com/en-us/windows/hardware/dn913721.aspx - -### Paths to adjust - -The Driver Package is going to copy the Driver Package Installer (DPInst) into the Build directory. (Only on Release Configurations) - -Normally the `WindowsSdkDir` Macro in Visual Studio should point to the Windows SDK 10 installation directory (which in turn contains the WDK). If not either fix it or change the path in the `Driver Package Properties` > `Driver Install` > `Package Files`. +All can be downloaded on this page: https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit ## Projects Overview @@ -31,6 +26,10 @@ Normally the `WindowsSdkDir` Macro in Visual Studio should point to the Windows Helper project to zip the Driver Packages after building. Has only Release Configurations, so should be only used on Release builds. Has a dependency on `HID Wiimote Package` so the package itself is build/rebuild as well. +### Release Versioning + +Utility project that generates different files containing the current version string. Version is parsed from package readme. + ### HID Miniport My own implementation of the MsHidKmdf driver, so I can pass some function addresses to the HID Wiimote driver. It basically just passes everything down to the HID Wiimote filter driver, additionally a custom IOCTL to request function addresses. @@ -39,14 +38,18 @@ My own implementation of the MsHidKmdf driver, so I can pass some function addre Main driver - does all the important Wiimote stuff. -### HID Wiimote Package +### HID Wiimote Control Center -Driver Package/Utility project, to pack everything into one package and sign it. No code, just settings. +User Mode Application to set specific device settings. Also includes an installer and updater. + +### HID Wiimote User Mode -### TinyInstaller +User Mode Managed Library to interact with Wiimote Devices. -My main installer written in C#. Just a helper to install my certificate to boost the driver ranking (so it will be picked instead of the default driver). Then invokes the Driver Package Installer (DPInst.exe). +### HID Wiimote Package + +Driver Package/Utility project, to pack everything into one package and sign it. No code, just settings. ## Contribution -Feel free to create issues, reporting bugs or giving feedback/features wishes. +Feel free to create issues, report bugs or give feedback/features wishes.