diff --git a/INSTALL b/INSTALL deleted file mode 100644 index a7c251e..0000000 --- a/INSTALL +++ /dev/null @@ -1,19 +0,0 @@ -INSTALLATION INSTRUCTIONS ---- - -To building on Android, run something like this: - - ruby ./configure.rb --host=arm-linux-androideabi \ - --with-ndk=/opt/android-ndk-r8c \ - --with-sdk=/opt/android-sdks - make - -For building on Linux or Solaris, run: - - ./configure - make - make install - -TODO -- Need to document for Windows - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d2f5ac --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +libkqueue +========= + +A user space implementation of the kqueue(2) kernel event notification mechanism +libkqueue acts as a translator between the kevent structure and the native +kernel facilities on Linux, Android, Solaris, and Windows. + +Supported Event Types +--------------------- + +* vnode +* socket +* proc +* user +* timer + +Installation - Linux, Solaris +----------------------------- + + ./configure + make + make install + +Installation - Red Hat +---------------------- + + ./configure + make package + rpm -i *.rpm + +Installation - Android +---------------------- + + ruby ./configure.rb --host=arm-linux-androideabi \ + --with-ndk=/opt/android-ndk-r8c \ + --with-sdk=/opt/android-sdks + make + +Running Unit Tests +------------------ + + ./configure + make + make check + +Building Applications +--------------------- + + CFLAGS += -I/usr/include/kqueue + LDFLAGS += -lkqueue + +Tutorials & Examples +-------------------- + +[Kqueues for Fun and Profit](http://doc.geoffgarside.co.uk/kqueue) + +[Handling TCP Connections with Kqueue Event Notification](http://eradman.com/posts//kqueue-tcp.html) + +Releases History +---------------- + +2.0 add support for Android _2013-04-29_ + +1.0 stable relesae for Linux, Solaris, and Windows _2010-09-18_