aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/um/wrappers/simple/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'um/wrappers/simple/README.md')
-rw-r--r--um/wrappers/simple/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/um/wrappers/simple/README.md b/um/wrappers/simple/README.md
new file mode 100644
index 0000000..51a46cb
--- /dev/null
+++ b/um/wrappers/simple/README.md
@@ -0,0 +1,43 @@
+simple driver utilities
+=======================
+
+[simple] driver usage examples.
+
+[simple]: ../../../km/src/simple
+
+Usage
+-----
+
+### exchange_ints.exe
+
+```
+Usage: exchange_ints.exe N
+```
+
+Parses its argument as an `unsigned int` and exchanges it with the one stored
+in [simple] driver's memory.
+For example:
+
+```
+> exchange_ints.exe 1
+42
+```
+
+```
+> exchange_ints.exe 32
+1
+```
+
+```
+> exchange_ints.exe 100500
+32
+```
+
+See also
+--------
+
+* [Building the utilities]
+* [License]
+
+[Building the utilities]: ../../README.md#building-the-utilities
+[License]: ../../../README.md#license