aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-08-12 05:59:15 +0200
committerMattias Andrée <maandree@operamail.com>2014-08-12 05:59:15 +0200
commitf4ef944feb3ca4235bb4a8306ba58f7462578c28 (patch)
tree30c154e1079340616e1797c75264ef8b63f0201b
parentadd install and uninstall rules (diff)
downloadalarm-f4ef944feb3ca4235bb4a8306ba58f7462578c28.tar.gz
alarm-f4ef944feb3ca4235bb4a8306ba58f7462578c28.tar.bz2
alarm-f4ef944feb3ca4235bb4a8306ba58f7462578c28.tar.xz
add readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README15
1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8778b5c
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Schedule an alarm for a program when starting it.
+
+
+USAGE: alarm <TIME> <COMMAND> <ARGS...>
+
+Recognised patterns for <TIME>:
+
+ <SECONDS>[s]
+ <MINUTES>m[<SECONDS>s]
+ <HOURS>h[<MINUTES>m][<SECONDS>s]
+
+ All values are non-negative integers, and
+ the interal must be greater than zero and
+ at most 18h12m15s.
+