Merge pull request #166 from barrygolden/master

Added metadata to README.md files

24 files changed, 241 insertions, 2 deletions

diff --git a/general/DCHU/README.md b/general/DCHU/README.md
index 58277b0c..92d7e76f 100644
--- a/general/DCHU/README.md
+++ b/general/DCHU/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: DHCU - Driver package installation toolkit for universal drivers 
+    platform: UMDF2
+    language: cpp
+    category: General DHCU
+    description: Illustrates DCHU principles of universal driver design.
+    samplefwlink: https://aka.ms/sceeqq
+--->
+
+
 # Driver package installation toolkit for universal drivers 
 
 This sample illustrates the DCHU principles of universal driver design.  The sample uses the [OSR FX2 learning kit](http://store.osr.com/product/osr-usb-fx2-learning-kit-v2/).  For a detailed code walkthrough, see [Universal Driver Scenarios](https://docs.microsoft.com/windows-hardware/drivers/develop/universal-driver-scenarios).
diff --git a/general/PLX9x5x/README.md b/general/PLX9x5x/README.md
index a706b7d0..e665839b 100644
--- a/general/PLX9x5x/README.md
+++ b/general/PLX9x5x/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: PLX9x5x PCI Driver
+    platform: KMDF
+    language: cpp
+    category: General PCI WDF
+    description: Demonstrates how to write a driver for a generic PCI device using Windows Driver Frameworks (WDF).
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617719
+--->
+
+
 PLX9x5x PCI Driver
 ==================
 
diff --git a/general/SystemDma/wdm/README.md b/general/SystemDma/wdm/README.md
index a077fe8d..ad7d9dbc 100644
--- a/general/SystemDma/wdm/README.md
+++ b/general/SystemDma/wdm/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: System DMA sample
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates how a driver could use a system DMA controller to write data to a hardware location using V3 System DMA.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617722
+--->
+
+
 System DMA
 ==========
 
diff --git a/general/cancel/README.md b/general/cancel/README.md
index 2a1be648..491ef673 100644
--- a/general/cancel/README.md
+++ b/general/cancel/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Cancel-Safe IRP Queue Sample
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates the use of the cancel-safe queue routines.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617705
+--->
+
+
 Cancel-Safe IRP Queue Sample
 ============================
 
diff --git a/general/echo/kmdf/README.md b/general/echo/kmdf/README.md
index 3b89850c..2ed4518a 100644
--- a/general/echo/kmdf/README.md
+++ b/general/echo/kmdf/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: KMDF Echo Sample
+    platform: KMDF
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to use a sequential queue to serialize read and write requests presented to the driver.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617706
+--->
+
+
 KMDF Echo Sample
 ================
 
diff --git a/general/echo/umdf/README.md b/general/echo/umdf/README.md
index e2123cd3..af4818d4 100644
--- a/general/echo/umdf/README.md
+++ b/general/echo/umdf/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Echo Sample (UMDF Version 1)
+    platform: UMDF1
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to use UMDF version 1 to write a driver and demonstrates best practices.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617707
+--->
+
+
 Echo Sample (UMDF Version 1)
 ============================
 
diff --git a/general/echo/umdf2/README.md b/general/echo/umdf2/README.md
index ba3ffa36..a9ec9e76 100644
--- a/general/echo/umdf2/README.md
+++ b/general/echo/umdf2/README.md
@@ -1,3 +1,12 @@
+<!---
+    name: Echo Sample (UMDF Version 2)
+    platform: UMDF2
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to use UMDF 2 to write a driver and to employ best practices.  
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617708
+--->
+
 Echo Sample (UMDF Version 2)
 ============================
 
diff --git a/general/echo/umdfSocketEcho/README.md b/general/echo/umdfSocketEcho/README.md
index 06819a47..26cd5a7e 100644
--- a/general/echo/umdfSocketEcho/README.md
+++ b/general/echo/umdfSocketEcho/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: UMDF SocketEcho Sample (UMDF Version 1)
+    platform: UMDF1
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to use UMDF version 1 to write a driver and demonstrates best practices. 
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617709
+--->
+
+
 UMDF SocketEcho Sample (UMDF Version 1)
 =======================================
 
diff --git a/general/event/README.md b/general/event/README.md
index c091af5a..68da1666 100644
--- a/general/event/README.md
+++ b/general/event/README.md
@@ -1,3 +1,13 @@
+<!--- 
+    name: Hardware Event Sample
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates different ways a kernel-mode driver can notify an application about a hardware event.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617711
+--->
+
+
 Hardware Event Sample
 =====================
 
diff --git a/general/filehistory/README.md b/general/filehistory/README.md
index 3e29b08e..7ed723d8 100644
--- a/general/filehistory/README.md
+++ b/general/filehistory/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: File History Sample
+    platform: WDM
+    language: cpp
+    category: General
+    description: A console application that starts the file history service, if it is stopped, and schedules regular backups.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617712
+--->
+
+
 File History Sample
 ==================
 
diff --git a/general/installwdf/README.md b/general/installwdf/README.md
index 429957d5..df9e8445 100644
--- a/general/installwdf/README.md
+++ b/general/installwdf/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: WDF Installation Package
+    platform: Tool
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to install WDF packages on a system.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617713
+--->
+
+
 WDF Installation Package
 ========================
 
diff --git a/general/ioctl/kmdf/README.md b/general/ioctl/kmdf/README.md
index c9a10365..9c3d80d4 100644
--- a/general/ioctl/kmdf/README.md
+++ b/general/ioctl/kmdf/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Non-PnP Driver Sample
+    platform: KMDF
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to write a non-PnP driver using the Kernel Mode Driver Framework. 
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620307
+--->
+
+
 Non-PnP Driver Sample
 ====================
 
diff --git a/general/ioctl/wdm/README.md b/general/ioctl/wdm/README.md
index fcbf71f2..e9e2e57d 100644
--- a/general/ioctl/wdm/README.md
+++ b/general/ioctl/wdm/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: IOCTL
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates usage of four different types of IOCTLs
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617715
+--->
+
+
 IOCTL
 =====
 
diff --git a/general/obcallback/README.md b/general/obcallback/README.md
index ca4069a2..37326565 100644
--- a/general/obcallback/README.md
+++ b/general/obcallback/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: ObCallback Callback Registration Driver
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates the use of registered callbacks for process protection.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617716
+--->
+
+
 ObCallback Callback Registration Driver
 =======================================
 
diff --git a/general/pcidrv/README.md b/general/pcidrv/README.md
index 04bf35b5..2fa15558 100644
--- a/general/pcidrv/README.md
+++ b/general/pcidrv/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: PCIDRV - WDF Driver for PCI Device
+    platform: KMDF
+    language: cpp
+    category: General PCI WDF
+    description: Demonstrates how to write a KMDF driver for a PCI device.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617717
+--->
+
+
 PCIDRV - WDF Driver for PCI Device
 ==================================
 
diff --git a/general/perfcounters/kcs/README.md b/general/perfcounters/kcs/README.md
index 1cbd3ac0..2e7553e5 100644
--- a/general/perfcounters/kcs/README.md
+++ b/general/perfcounters/kcs/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Kernel Counter Sample (Kcs)
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates the use of the kernel-mode performance library.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617718
+--->
+
+
 Kernel Counter Sample (Kcs)
 ===========================
 
diff --git a/general/registry/regfltr/README.md b/general/registry/regfltr/README.md
index 9e5a0740..40fe7011 100644
--- a/general/registry/regfltr/README.md
+++ b/general/registry/regfltr/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: RegFltr Sample Driver
+    platform: WDM
+    language: cpp
+    category: General
+    description: Demonstrates how to write a registry filter driver. 
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617720
+--->
+
+
 RegFltr Sample Driver
 =====================
 
diff --git a/general/toaster/toastDrv/README.md b/general/toaster/toastDrv/README.md
index 326d40a9..4a29ff7d 100644
--- a/general/toaster/toastDrv/README.md
+++ b/general/toaster/toastDrv/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Toaster Sample Driver
+    platform: KMDF UDMF1
+    language: cpp
+    category: General WDF
+    description: An iterative series of samples that demonstrate KDMF and UDMF1 driver development.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620309
+--->
+
+
 Toaster Sample Driver
 =====================
 The Toaster collection is an iterative series of samples that demonstrate fundamental aspects of Windows driver development for both Kernel-Mode Driver Framework (KMDF) and User-Mode Driver Framework (UMDF) version 1.
diff --git a/general/toaster/toastpkg/README.md b/general/toaster/toastpkg/README.md
index 326d40a9..a4763177 100644
--- a/general/toaster/toastpkg/README.md
+++ b/general/toaster/toastpkg/README.md
@@ -1,5 +1,15 @@
-Toaster Sample Driver
-=====================
+<!---
+    name: Toaster Package Sample Driver
+    platform: WDM
+    language: cpp
+    category: General
+    description: Simulates hardware-first and software-first installation of the toaster sample driver.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617723
+--->
+
+
+Toaster Package Sample Driver
+=============================
 The Toaster collection is an iterative series of samples that demonstrate fundamental aspects of Windows driver development for both Kernel-Mode Driver Framework (KMDF) and User-Mode Driver Framework (UMDF) version 1.
 
 All the samples work with a hypothetical toaster bus, over which toaster devices can be connected to a PC.
diff --git a/general/toaster/umdf2/README.md b/general/toaster/umdf2/README.md
index 9dcdd158..75cf882b 100644
--- a/general/toaster/umdf2/README.md
+++ b/general/toaster/umdf2/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Toaster Sample (UMDF version 2)
+    platform: UMDF2
+    language: cpp
+    category: General WDF
+    description: An iterative series of samples that demonstrate driver development using UMDF version 2.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620310
+--->
+
+
 Toaster Sample (UMDF Version 2)
 ===============================
 The Toaster (UMDF version 2) sample is an iterative series of samples that demonstrate fundamental aspects of Windows driver development.
diff --git a/general/tracing/SystemTraceControl/README.md b/general/tracing/SystemTraceControl/README.md
index eb044ddb..b45ae788 100644
--- a/general/tracing/SystemTraceControl/README.md
+++ b/general/tracing/SystemTraceControl/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: System Trace Control
+    platform: Application
+    language: cpp
+    category: General Tracing
+    description: Demonstrates how to use event tracing control APIs to collect events from the system trace provider.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617725
+--->
+
+
 SystemTraceProvider
 ===================
 
diff --git a/general/tracing/evntdrv/README.md b/general/tracing/evntdrv/README.md
index 4e64ecae..41359ad1 100644
--- a/general/tracing/evntdrv/README.md
+++ b/general/tracing/evntdrv/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Eventdrv
+    platform: Application
+    language: cpp
+    category: General Tracing
+    description: Demonstrates the use of the Event Tracing for Windows (ETW) API in a driver. 
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617724
+--->
+
+
 Eventdrv
 ========
 
diff --git a/general/tracing/tracedriver/README.md b/general/tracing/tracedriver/README.md
index 064fb133..358053a1 100644
--- a/general/tracing/tracedriver/README.md
+++ b/general/tracing/tracedriver/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: Tracedrv
+    platform: Application
+    language: cpp
+    category: General Tracing
+    description: A sample driver instrumented for software tracing.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617726
+--->
+
+
 Tracedrv
 ========
 
diff --git a/general/umdfSkeleton/README.md b/general/umdfSkeleton/README.md
index 923f44df..85d384f5 100644
--- a/general/umdfSkeleton/README.md
+++ b/general/umdfSkeleton/README.md
@@ -1,3 +1,13 @@
+<!---
+    name: UMDF Driver Skeleton Sample (UMDF version 1)
+    platform: UDMF1
+    language: cpp
+    category: General WDF
+    description: Demonstrates how to use UDMF to write a minimal driver.
+    samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617727
+--->
+
+
 UMDF Driver Skeleton Sample (UMDF Version 1)
 ============================================