README

   1 = sleepy_penguin - Linux I/O events for Ruby
   2
   3 sleepy_penguin provides access to newer, Linux-only system calls to wait
   4 on events from traditionally non-I/O sources.  Bindings to the eventfd,
   5 timerfd, inotify, and epoll interfaces are provided.  Experimental support
   6 for kqueue on FreeBSD (and likely OpenBSD/NetBSD) are also provided.
   7
   8 == Features
   9
  10 * Thread-safe blocking operations for all versions of Matz Ruby
  11
  12 * IO-like objects are backwards-compatible with IO.select.
  13
  14 * High-level Epoll interface is fork-safe and GC-safe
  15
  16 * Unlike portable event frameworks, the Linux-only epoll interfaces
  17   allow using edge-triggered or one-shot notifications for possibly
  18   improved performance.  Likewise, the kqueue interface supports
  19   one-shot notifiactions, too.
  20
  21 * Fully-documented and user-friendly API
  22
  23 == Install
  24
  25 If you're using a packaged Ruby distribution, make sure you have a C
  26 compiler and the matching Ruby development libraries and headers.
  27
  28 If you use RubyGems:
  29
  30     gem install sleepy_penguin
  31
  32 Otherwise grab the latest tarball from:
  33
  34 http://bogomips.org/sleepy_penguin/files/
  35
  36 Unpack it, and run "ruby setup.rb"
  37
  38 == Development
  39
  40 You can get the latest source via git from the following locations:
  41
  42   git://bogomips.org/sleepy_penguin.git
  43   git://repo.or.cz/sleepy_penguin.git (mirror)
  44
  45 You may browse the code from the web and download the latest snapshot
  46 tarballs here:
  47
  48 * http://bogomips.org/sleepy_penguin.git (cgit)
  49 * http://repo.or.cz/w/sleepy_penguin.git (gitweb)
  50
  51 Inline patches (from "git format-patch") to the mailing list are
  52 preferred because they allow code review and comments in the reply to
  53 the patch.
  54
  55 We will adhere to mostly the same conventions for patch submissions as
  56 git itself.  See the Documentation/SubmittingPatches document
  57 distributed with git on on patch submission guidelines to follow.  Just
  58 don't email the git mailing list or maintainer with sleepy_penguin patches.
  59
  60 == Contact
  61
  62 All feedback (bug reports, user/development discussion, patches, pull
  63 requests) go to the mailing list: mailto:sleepy-penguin@bogomips.org
  64
  65 * Mailing list archives: http://bogomips.org/sleepy-penguin/