From 1fc5c23997c7423fddca9b29ac12f77efe8fb6de Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Sun, 22 May 2016 00:51:09 +0300
Subject: README updates

---
 utils/README.md                      | 43 ++++++++++++++++++++----------------
 utils/libnt_path_converter/README.md | 22 ++++++------------
 utils/libservice/README.md           | 20 +++++------------
 utils/libtest/README.md              | 18 +++++----------
 4 files changed, 42 insertions(+), 61 deletions(-)

(limited to 'utils')

diff --git a/utils/README.md b/utils/README.md
index 7dcf890..eed64ab 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,30 +1,35 @@
 # Driver utilities
 
-A few usage examples are provided along with the drivers.
-Those include:
+A couple of usage examples are included along with the drivers.
 
-* [libservice]: utilities to easily install/start/stop/uninstall drivers
-  (using Windows services),
-* [libtest]: [test] driver usage examples,
-* [libnt_path_converter]: [nt_path_converter] usage examples.
+* [libservice]: Utilities to load/unload the drivers.
+* [libtest]: [test] driver usage examples.
+* [libnt_path_converter]: [nt_path_converter] driver usage examples.
 
-## Building
+[libservice]: libservice/README.md
+[libtest]: libtest/README.md
+[test]: ../src/test
+[libnt_path_converter]: libnt_path_converter/README.md
+[nt_path_converter]: ../src/nt_path_converter
 
-To build the utilities:
+## Building the utilities
 
-1. generate the solution windows7_drivers_utils.sln using CMake,
-2. build the solution using Visual Studio.
+Create the build files using CMake and build using Visual Studio.
 
-## License
+For example, using Visual Studio 2013 Update 4 for Windows Desktop (targetting
+x86):
 
-This project is licensed under the terms of the MIT License.
-See [License] for details.
+    > cd
+    C:\workspace\personal\build\windows7-drivers\utils
 
+    > cmake -G "Visual Studio 12 2013" C:\workspace\personal\windows7-drivers\utils
+    ...
 
+    > msbuild windows7_drivers_utils.sln
+    ...
 
-[license]: ../README.md#license
-[libservice]: libservice/README.md
-[libtest]: libtest/README.md
-[test]: ../src/test
-[libnt_path_converter]: libnt_path_converter/README.md
-[nt_path_converter]: ../src/nt_path_converter
+## License
+
+See [License].
+
+[License]: ../README.md#license
diff --git a/utils/libnt_path_converter/README.md b/utils/libnt_path_converter/README.md
index 43375e0..b3cde53 100644
--- a/utils/libnt_path_converter/README.md
+++ b/utils/libnt_path_converter/README.md
@@ -2,14 +2,9 @@
 
 [nt_path_converter] driver usage examples.
 
-## Library
-
-[nt_path_converter] driver's virtual device is wrapped into a separate library
-`libnt_path_converter` using [libservice].
-`#include <libnt_path_converter/all.hpp>` and link with
-`libnt_path_converter.lib` to use the library.
+[nt_path_converter]: ../../src/nt_path_converter
 
-## Utilities
+## Usage
 
 ### convert_nt_path.exe
 
@@ -22,15 +17,12 @@ For example:
     > convert_nt_path.exe \Device\HarddiskVolume2\Windows
     C:\Windows
 
+[WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx
+
 ## See also
 
-* [Building]
+* [Building the utilities]
 * [License]
 
-
-
-[building]: ../README.md#building
-[license]: ../../README.md#license
-[nt_path_converter]: ../../src/nt_path_converter
-[libservice]: ../libservice/README.md
-[WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx
+[Building the utilities]: ../README.md#building-the-utilities
+[License]: ../../README.md#license
diff --git a/utils/libservice/README.md b/utils/libservice/README.md
index 22c9388..2727f31 100644
--- a/utils/libservice/README.md
+++ b/utils/libservice/README.md
@@ -1,14 +1,8 @@
-# Service management utilities
+# Driver management utilities
 
-Utilities to easily install/start/stop/uninstall drivers using Windows
-services.
+Utilities to load/unload the drivers.
 
-## Library
-
-`#include <libservice/all.hpp>` and link with `libservice.lib` to use the
-library.
-
-## Utilities
+## Usage
 
 ### install_service.exe
 
@@ -49,10 +43,8 @@ The same as
 
 ## See also
 
-* [Building]
+* [Building the utilities]
 * [License]
 
-
-
-[building]: ../README.md#building
-[license]: ../../README.md#license
+[Building the utilities]: ../README.md#building-the-utilities
+[License]: ../../README.md#license
diff --git a/utils/libtest/README.md b/utils/libtest/README.md
index 4992849..ddab9ce 100644
--- a/utils/libtest/README.md
+++ b/utils/libtest/README.md
@@ -2,13 +2,9 @@
 
 [test] driver usage examples.
 
-## Library
-
-[test] driver's virtual device is wrapped into a separate library `libtest`
-using [libservice].
-`#include <libtest/all.hpp>` and link with `libtest.lib` to use the library.
+[test]: ../../src/test
 
-## Utilities
+## Usage
 
 ### exchange_ints.exe
 
@@ -29,12 +25,8 @@ For example:
 
 ## See also
 
-* [Building]
+* [Building the utilities]
 * [License]
 
-
-
-[building]: ../README.md#building
-[license]: ../../README.md#license
-[test]: ../../src/test
-[libservice]: ../libservice/README.md
+[Building the utilities]: ../README.md#building-the-utilities
+[License]: ../../README.md#license
-- 
cgit v1.2.3