Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Minor changes to documentation

  • Loading branch information...
commit 3b6ca2f9875def43898fc5911cccd8081b25e370 1 parent 62bf07a
@wedesoft authored
Showing with 49 additions and 1 deletion.
  1. +49 −1 README.md
View
50 README.md
@@ -1,4 +1,52 @@
hornetseye-xorg
-======
+===============
+
+**Author**: Jan Wedekind
+**Copyright**: 2010
+**License**: GPL
+
+Synopsis
+--------
+
This Ruby extension provides graphical output under X.Org.
+Installation
+------------
+
+*hornetseye-xorg* requires the X.Org headers. If you are running Debian or (K)ubuntu, you can install them like this:
+
+ $ sudo aptitude install xserver-xorg-dev
+
+To install this Ruby extension, use the following command:
+
+ $ sudo gem install hornetseye-xorg
+
+Alternatively you can build and install the Ruby extension from source as follows:
+
+ $ rake
+ $ sudo rake install
+
+Usage
+-----
+
+Simply run Interactive Ruby:
+
+ $ irb
+
+You can load and use the X.Org wrappers as shown below. This example shows how to display an image:
+
+ require 'rubygems'
+ require 'hornetseye_xorg'
+ include Hornetseye
+ img = lazy( 640, 480 ) { RGB 255, 0, 0 }
+ img.show
+
+Here is another example. It demonstrates display of a video:
+
+ require 'rubygems'
+ require 'hornetseye_xorg'
+ include Hornetseye
+ X11Display.show do
+ lazy( 320, 240 ) { RGB ( Time.new.to_f * 256 ) % 256, 0, 0 }
+ end
+
Please sign in to comment.
Something went wrong with that request. Please try again.