aboutsummaryrefslogtreecommitdiffstats
path: root/doc/examples/timed/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/examples/timed/README')
-rw-r--r--doc/examples/timed/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/examples/timed/README b/doc/examples/timed/README
new file mode 100644
index 0000000..b0989bf
--- /dev/null
+++ b/doc/examples/timed/README
@@ -0,0 +1,18 @@
+API usage example
+
+This example shows how to use timed operations.
+
+
+
+First of, run make to build this example.
+
+To start the example run ./init.
+When you are done run ./cleanup.
+
+Running instances of ./poll will wait for new messages
+continuously, but with one second timeouts.
+
+./poll, ./init and ./cleanup are run without any
+additional arguments. ./write is run with the message
+as the second argument.
+