aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/utils/libtest
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-05-20 21:26:26 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-05-20 21:26:26 +0300
commit96872487d024fed9cb089fa876ccf2c9e960874a (patch)
treef70723882a9b2e3ee0a502de0f9d897b6d8416ec /utils/libtest
parentREADME update (diff)
downloadwindows7-drivers-96872487d024fed9cb089fa876ccf2c9e960874a.tar.gz
windows7-drivers-96872487d024fed9cb089fa876ccf2c9e960874a.zip
README updates
Diffstat (limited to '')
-rw-r--r--utils/libtest/README.md33
1 files changed, 18 insertions, 15 deletions
diff --git a/utils/libtest/README.md b/utils/libtest/README.md
index dae0cfe..4992849 100644
--- a/utils/libtest/README.md
+++ b/utils/libtest/README.md
@@ -1,22 +1,22 @@
-# libtest
+# test driver utilities
-[test](../../src/test) usage examples.
+[test] driver usage examples.
-## Usage
+## Library
-### libtest.lib
+[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.
-Wraps `test`'s virtual device interface using [libservice](../libservice).
-Include the headers by `#include`ing `libtest/all.hpp`, which includes all the
-other header files.
+## Utilities
### exchange_ints.exe
Usage: exchange_ints.exe N
-Parses a given `unsigned int` and exchanges it with the value stored in
-driver's memory.
-Usage example (assuming `test` is already loaded):
+Parses its argument as an `unsigned int` and exchanges it with the one stored
+in [test] driver's memory.
+For example:
> exchange_ints.exe 1
42
@@ -27,11 +27,14 @@ Usage example (assuming `test` is already loaded):
> exchange_ints.exe 100500
32
-## Building
+## See also
-See [Building](../README.md#building).
+* [Building]
+* [License]
-## Licensing
-This project is licensed under the terms of the MIT License.
-See [Licensing](../../README.md#licensing) for details.
+
+[building]: ../README.md#building
+[license]: ../../README.md#license
+[test]: ../../src/test
+[libservice]: ../libservice/README.md