Skip to content
Browse files

Removing website, updating readme

  • Loading branch information...
1 parent 2d90730 commit accfe549337c2ea539d8f321e33371cfc4ba4d2f @nilium committed Mar 3, 2012
Showing with 91 additions and 198 deletions.
  1. +91 −1 README.md
  2. +0 −87 website/index.html
  3. +0 −110 website/style.css
View
92 README.md
@@ -1 +1,91 @@
-See file website/index.html
+# ruby-glfw
+
+## What is ruby-glfw?
+
+ruby-glfw contains Ruby bindings for the [GLFW library]. This currently
+includes the GLFW 2.7.3 source code in the package. This particular fork is my
+attempt to fix some build issues in ruby-glfw, and is based on the old
+[ruby-glfw gem][deathtrap] (unmaintained since 2008-ish) by Jan Dvorak.
+
+
+## What's GLFW?
+
+A convenient quote from [glfw.org][GLFW library]:
+
+> GLFW is a free, Open Source, multi-platform library for opening a window,
+> creating an OpenGL context and managing input. It is easy to integrate into
+> existing applications and does not lay claim to the main loop.
+
+Yeah, that about sums it up. It handles the things that aren't exciting so you
+can write the cool stuff.
+
+
+## What platforms are supported?
+
+Though the original ruby-glfw gem claimed support for the three major OSes,
+Linux, Windows, and OS X, I cannot say the same since I haven't tested my fork
+on anything other than OS X.
+
+So, OS X is the only supported platform. If you do test this on another OS, do
+let me know.
+
+-------------------------------------------------------------------------------
+
+Because you might be looking for a list and skipping what I wrote above:
+
+* OS X: Works
+* Windows: Untested
+* Any variety of Linux: Untested
+* Obscure OSes only three people use: Untested
+
+
+## Installation
+
+I am only using ruby-glfw under Ruby 1.9.3, so it will _probably_ work under
+1.9.x, but consider yourself warned. Chances are nothing in use requires
+1.9 and up, however, and ruby-glfw originally supported 1.8.5, so just give
+it a shot if you're still on 1.8.5 or higher.
+
+Run `rake package` and install the gem (under _pkg/_) and you should be fine.
+
+ $ rake package
+ $ cd pkg
+ $ sudo gem install ruby-glfw-0.9.2.gem
+
+Substitute 0.9.2 for whatever version number you've packages, of course.
+
+#### Support Notes
+
+Some additional notes from Jan Dvorak's HTML readme thing that accompanied
+ruby-glfw (why it was an HTML file is beyond me), most of which I've edited for
+some correctness:
+
+* _Windows notes:_ Originally, ruby-glfw required MSVC 6.0 -- shame on Jan for
+ this. You need MinGW to build from this particular fork of ruby-glfw. I don't
+ know if it works, but requiring MSVC 6.0 is cruel and unusual.
+
+ There was also a binary gem available, this is still true for the [old gem].
+ I take no responsibility for whether that works.
+
+* _Mac OS X notes:_ You may need a version of Ruby from someplace other than
+ Apple, though this is not required under Mac OS 10.7 (Lion). Consider using
+ [rbenv] and [ruby-build] to handle this cleanly. Avoid RVM if you can help
+ it -- RVM wreaks havoc on your shell.
+
+* _Linux notes:_ On some distributions you may need aditional development
+ packages, like xorg-dev or ruby1.8-dev.
+
+[rbenv]: https://github.com/sstephenson/rbenv
+[ruby-build]: https://github.com/sstephenson/ruby-build
+[old gem]: http://rubyforge.org/frs/?group_id=4539
+
+
+## Links
+
+* Project page: https://github.com/nilium/ruby-glfw
+* The old ruby-glfw: http://ruby-glfw.rubyforge.org/
+* GLFW: http://www.glfw.org
+
+
+[GLFW library]: http://www.glfw.org
+[deathtrap]: http://ruby-glfw.rubyforge.org/
View
87 website/index.html
@@ -1,87 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-
-<head profile="http://gmpg.org/xfn/11">
- <title>Ruby bindings for GLFW library</title>
- <link rel="shortcut icon" href="image/favicon.ico" />
- <link rel="stylesheet" href="style.css" type="text/css" media="screen" />
- <meta http-equiv="content-type" content="text/html; charset=utf-8" />
- <meta http-equiv="content-language" content="en-us" />
- <meta http-equiv="imagetoolbar" content="false" />
- <meta name="author" content="Jan Dvorak" />
- <meta name="copyright" content="Copyright (c) Jan Dvorak 2008" />
- <meta name="description" content="Ruby bindings for GLFW library" />
- <meta name="keywords" content="ruby glfw opengl bindings" />
- <meta name="last-modified" content="Sat, 18 Aug 2008 00:00:00 GMT" />
- <meta name="mssmarttagspreventparsing" content="true" />
- <meta name="robots" content="index, follow, noarchive" />
- <meta name="revisit-after" content="7 days" />
-</head>
-
-<body>
- <div id="header">
- <h1>Ruby bindings for GLFW library</h1>
- </div>
- <div id="content">
-
-<h1>Introduction</h1>
-<p>This project contains <a href="http://www.ruby-lang.org">Ruby</a> bindings for <a href="http://glfw.sourceforge.net">GLFW library</a>. The package
-also includes the GLFW library itself, due to the fact that the library is small and generally not preinstalled on target operating systems.</p>
-
-<p>GLFW is a free, Open Source, portable framework for <a href="http://www.opengl.org">OpenGL</a> application
-development. In short, it is a single library providing a powerful,
-portable API for otherwise operating system specific tasks such as
-opening an OpenGL window, and reading keyboard, time, mouse and joystick
-input.</p>
-
-<p>Both the bindings and the GLFW library are licensed under <a href="http://www.opensource.org/licenses/zlib-license.php">zlib/libpng license</a>.</p>
-
-<p>Currently tested and supported systems are Linux, Mac OS X and Windows, although any POSIX compatible system should work as well.</p>
-
-<h1>Contact</h1>
-
-<p> You can visit the <a href="http://rubyforge.org/projects/ruby-glfw/">project page</a> on rubyforge -
-there you can fill in <a href="http://rubyforge.org/tracker/?atid=17530&amp;group_id=4539&amp;func=browse">bug reports</a> or join <a href="http://rubyforge.org/mail/?group_id=4539">mailing list</a>.</p>
-<p> I can be reached directly at <a href="mailto:jan.dvorak@kraxnet.cz">jan.dvorak@kraxnet.cz</a></p>
-
-<h1>Usage and API</h1>
-<p>For usage information and API documentation see the <a href="rdoc/index.html">RDoc page</a>.</p>
-
-<h1>Download</h1>
-<p>Latest stable version: <a href="http://rubyforge.org/frs/?group_id=4539">0.9.1</a> / 17 Aug 2008</p>
-<p>Changes from last version: </p>
-<ul>
- <li>Build fix for 64-bit platforms</li>
- <li>Other minor bugfixes</li>
-</ul>
-<p>You can install directly from gems by typing '<b>gem install ruby-glfw</b>' (see below for notes)</p>
-<p>Additionaly, you can also access the <a href="http://rubyforge.org/scm/?group_id=4539">SVN repository.</a></p>
-
-<h1>Installation</h1>
-<p>You need of course ruby(1.8.5+), C compiler, and rake and mkrf(0.20+) (both can be
-installed from gems). You would probably want to install <a href="http://ruby-opengl.rubyforge.org">ruby-opengl</a>
-as well, although it is not required for the installation process itself.</p>
-
-<p><b>Windows notes:</b> Binary version of ruby-glfw gem is available for windows - for that you don't need C compiler, just
-the ruby one-click installer and mkrf + rake from gems. In case you decide to compile the source gem, you will need the
-same compiler that was used to compile the ruby binary (in case of the one-click installer it is MSVC 6.0). You may need to
-tweak the Rakefile if you're using other compiler than MSVC.</p>
-
-<p><b>Mac OS X notes:</b> You will need ruby version from ports (macports or fink), and also Xcode framework which you can
-download from apple.</p>
-
-<p><b>Linux notes:</b> On some distributions you may need aditional development packages, like xorg-dev or ruby1.8-dev.</p>
-
-<h1>Limitations</h1>
-
-<p>The GLFW threading is not implemented, as ruby has its own threading API.</p>
-<p>glfwGetProcAddress is also not implemented, use ruby-opengl functions instead</p>
-
-<p></p>
-</div>
- <div id="footer">
- <p>Copyright &copy; <a href="mailto:jan.dvorak@kraxnet.cz">Jan Dvorak</a> 2009 | Design by <a href="http://www.edg3.co.uk/">edg3.co.uk</a> via <a href="http://www.opendesigns.org/">Open Designs</a> | Valid <a href="http://jigsaw.w3.org/css-validator/">CSS</a> &amp; <a href="http://validator.w3.org/">XHTML</a></p>
- </div>
-</body>
-
-</html>
View
110 website/style.css
@@ -1,110 +0,0 @@
-/*
- Author : Christopher Robinson
- Email : christopher@edg3.co.uk
- Website : http://www.edg3.co.uk/
-*/
-* {
- border:0;
- margin:0;
- padding:0;
-}
-
-/* general */
-a {
- color:#33c;
- text-decoration:none;
-}
-
-a:hover {
- color:#33c;
- text-decoration:underline;
-}
-
-/* body */
-body {
- background:#fafafa;
- color:#555;
- font:0.8em Arial, Helvetica, "bitstream vera sans", sans-serif;
-}
-
-/* header */
-#header {
- border-bottom:1px solid #999;
- height:80px;
- margin:0 auto;
- width:751px;
-}
-#header h1 {
- color:#888;
- font-size:300%;
- letter-spacing:-3px;
- text-align:right;
- padding:5px;
- margin-bottom:-20px;
-}
-#header h2 {
- color:#CCC;
- font-size:200%;
- letter-spacing:-2px;
- text-align:right;
-}
-
-/* navigation */
-#navigation {
- background:#fafafa;
- border-right:1px solid #999;
- margin:0 auto;
- width:750px;
- height:50px;
- list-style:none;
-}
-#navigation li {
- border-left:1px solid #999;
- float:left;
- width:124px;
- list-style:none;
-}
-#navigation a {
- color:#555;
- display:block;
- line-height:50px;
- text-align:center;
-}
-#navigation a:hover {
- background:#e3e3e3;
- color:#555;
-}
-#navigation .active {
- background:#e3e3e3;
- color:#777;
-}
-
-/* content */
-#content {
- height:auto;
- margin:0 auto;
- padding:0 0 20px;
- width:751px;
-}
-#content h1 {
- border-bottom:1px dashed #999;
- font-size:1.8em;
- padding:20px 0 0;
-}
-#content p {
- padding:20px 20px 0;
-}
-
-#content ul {
- padding:0 40px 0;
-}
-
-/* footer */
-#footer {
- border-top:1px solid #999;
- height:50px;
- margin:0 auto;
- padding:10px;
- text-align:center;
- width:751px;
-}

0 comments on commit accfe54

Please sign in to comment.
Something went wrong with that request. Please try again.