Permalink
Browse files

Add a simple README

  • Loading branch information...
1 parent 9c6897b commit 056423c1e30b1eb602afd0060e4968c39a1e92ad @rtyler rtyler committed Jun 25, 2010
Showing with 42 additions and 0 deletions.
  1. +42 −0 README.markdown
View
@@ -0,0 +1,42 @@
+itimer
+=======
+
+The `itimer` module adds support for sub-second alarm signal delivery
+on systems that support `setitimer(2)` and `getitimer(2)`. Usage is
+very similar to sending alarm signals with the built-in `signal` module:
+
+ import itimer
+ import signal
+ import time
+
+ def handler(*args, **kwargs):
+ print 'Alarm! (%s)' % time.time()
+
+ def main():
+ signal.signal(signal.SIGALRM, handler)
+
+ cont = True
+ while cont:
+ try:
+ time.sleep(1)
+ itimer.alarm(0.5)
+ except KeyboardInterrupt:
+ cont = False
+ return 0
+
+ if __name__ == '__main__':
+ exit(main())
+
+(The example above will fire SIGALRM signals every 0.5s)
+
+
+License
+========
+
+See the `LICENSE` file
+
+
+Authors
+=========
+
+`itimer` was originally written by Libor Michalek at [Slide, Inc.](http://github.com/slideinc)

0 comments on commit 056423c

Please sign in to comment.