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, signalfd and epoll interfaces are provided.
   6
   7 == Features
   8
   9 * Thread-safe blocking operations under both Ruby 1.8 and 1.9.
  10
  11 * IO-like objects are backwards-compatible with IO.select.
  12
  13 * Epoll interface is fork-safe and GC-safe
  14
  15 * Unlike portable event frameworks, the Linux-only Epoll interface
  16   allows using edge-triggered I/O for possibly improved performance
  17
  18 * Fully-documented and user-friendly API
  19
  20 == Install
  21
  22 If you're using a packaged Ruby distribution, make sure you have a C
  23 compiler and the matching Ruby development libraries and headers.
  24
  25 If you use RubyGems:
  26
  27     gem install sleepy_penguin
  28
  29 Otherwise grab the latest tarball from:
  30
  31 http://bogomips.org/sleepy_penguin/files/
  32
  33 Unpack it, and run "ruby setup.rb"
  34
  35 == Development
  36
  37 You can get the latest source via git from the following locations:
  38
  39   git://bogomips.org/sleepy_penguin.git
  40   git://repo.or.cz/sleepy_penguin.git (mirror)
  41
  42 You may browse the code from the web and download the latest snapshot
  43 tarballs here:
  44
  45 * http://bogomips.org/sleepy_penguin.git (cgit)
  46 * http://repo.or.cz/w/sleepy_penguin.git (gitweb)
  47
  48 Inline patches (from "git format-patch") to the mailing list are
  49 preferred because they allow code review and comments in the reply to
  50 the patch.
  51
  52 We will adhere to mostly the same conventions for patch submissions as
  53 git itself.  See the Documentation/SubmittingPatches document
  54 distributed with git on on patch submission guidelines to follow.  Just
  55 don't email the git mailing list or maintainer with sleepy_penguin patches.
  56
  57 == Contact
  58
  59 All feedback (bug reports, user/development discussion, patches, pull
  60 requests) go to the mailing list: mailto:sleepy.penguin@librelist.com
  61
  62 * http://bogomips.org/sleepy_penguin/archives/