README

   1 = sleepy_penguin - Ruby event extensions for Linux
   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 signalfd, timerfd, 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 == Install
  14
  15 If you're using a packaged Ruby distribution, make sure you have a C
  16 compiler and the matching Ruby development libraries and headers.
  17
  18 If you use RubyGems:
  19
  20     gem install sleepy_penguin
  21
  22 Otherwise grab the latest tarball from:
  23
  24 http://bogomips.org/sleepy_penguin/files/
  25
  26 Unpack it, and run "ruby setup.rb"
  27
  28 == Development
  29
  30 You can get the latest source via git from the following locations:
  31
  32   git://git.bogomips.org/sleepy_penguin.git
  33   git://repo.or.cz/sleepy_penguin.git (mirror)
  34
  35 You may browse the code from the web and download the latest snapshot
  36 tarballs here:
  37
  38 * http://git.bogomips.org/cgit/sleepy_penguin.git (cgit)
  39 * http://repo.or.cz/w/sleepy_penguin.git (gitweb)
  40
  41 Inline patches (from "git format-patch") to the mailing list are
  42 preferred because they allow code review and comments in the reply to
  43 the patch.
  44
  45 We will adhere to mostly the same conventions for patch submissions as
  46 git itself.  See the Documentation/SubmittingPatches document
  47 distributed with git on on patch submission guidelines to follow.  Just
  48 don't email the git mailing list or maintainer with sleepy_penguin patches.
  49
  50 == Contact
  51
  52 All feedback (bug reports, user/development discussion, patches, pull
  53 requests) go to the mailing list: mailto:sleepy.penguin@librelist.com
  54
  55 * http://bogomips.org/sleepy_penguin/archives/