Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 85 lines (58 sloc) 2.693 kB
c212f37 @jacius Added README.rdoc.
jacius authored
1
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
2 = Ruby-SDL-FFI
c212f37 @jacius Added README.rdoc.
jacius authored
3
6f84fb5 @jacius Ruby-SDL-FFI 0.4 released.
jacius authored
4 Version:: 0.4
5 Date:: 2011-03-06
c212f37 @jacius Added README.rdoc.
jacius authored
6
46b8d58 @jacius Updated homepage URLs.
jacius authored
7 Homepage:: http://github.com/rubygame/ruby-sdl-ffi/
c212f37 @jacius Added README.rdoc.
jacius authored
8 Author:: John Croisant <jacius@gmail.com>
6f84fb5 @jacius Ruby-SDL-FFI 0.4 released.
jacius authored
9 Copyright:: 2009-2011 John Croisant
c212f37 @jacius Added README.rdoc.
jacius authored
10
11
12 == Description
13
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
14 Ruby-SDL-FFI is a low-level binding to SDL [1] and related
8579e5f @jacius Updated README.rdoc.
jacius authored
15 libraries using Ruby-FFI [2] or compatible FFI APIs, such as
16 JRuby's. It provides very basic access to SDL from Ruby [3]
17 without the need for a compiled C wrapper. It aims to be
18 platform and Ruby implementation independent.
c212f37 @jacius Added README.rdoc.
jacius authored
19
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
20 Ruby-SDL-FFI does not attempt to provide any high-level
c212f37 @jacius Added README.rdoc.
jacius authored
21 functionality, only to mirror the standard SDL interface.
22 For higher-level functionality, you should use other
23 libraries (Rubygame [4], Gosu [5], etc.).
24
25 1. SDL: http://www.libsdl.org/
8579e5f @jacius Updated README.rdoc.
jacius authored
26 2. Ruby-FFI: http://github.com/ffi/ffi
c212f37 @jacius Added README.rdoc.
jacius authored
27 3. Ruby: http://www.ruby-lang.org/en/
28 4. Rubygame: http://rubygame.org/
3366a73 @jacius Fixed link for Gosu in README.
jacius authored
29 5. Gosu: http://www.libgosu.org/
c212f37 @jacius Added README.rdoc.
jacius authored
30
31
32 == Caveats
33
65d41d2 @jacius Updated NEWS.rdoc, README.rdoc, and ruby-sdl-ffi.gemspec for version …
jacius authored
34 Ruby-SDL-FFI is still in EARLY DEVELOPMENT STAGES. That means:
c212f37 @jacius Added README.rdoc.
jacius authored
35
36 * It may not work correctly (or at all).
37 * It may not be complete.
38 * It may change drastically with no advanced notice.
39
40 As such, this library is currently FOR THE ADVENTUROUS ONLY.
41 If you are not willing to continuously update your code to
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
42 match the new API, then you should wait until Ruby-SDL-FFI is
c212f37 @jacius Added README.rdoc.
jacius authored
43 more mature and stable (i.e. version 1.0+).
44
45
46 == Requirements
47
48 * SDL >= 1.2.13
1705f10 @jacius Updated README.rdoc.
jacius authored
49 * Nice-FFI >= 0.2.0
c212f37 @jacius Added README.rdoc.
jacius authored
50
36fcdd9 @jacius Updated README to mention other SDL-related libraries.
jacius authored
51 Optional:
52
53 * SDL_image >= 1.2.7
8579e5f @jacius Updated README.rdoc.
jacius authored
54 * SDL_gfx >= 2.0.13
36fcdd9 @jacius Updated README to mention other SDL-related libraries.
jacius authored
55 * SDL_mixer >= 1.2.8
56 * SDL_ttf >= 2.0.9
57
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
58 Ruby-SDL-FFI may work with older versions, but hasn't been tried on them.
c212f37 @jacius Added README.rdoc.
jacius authored
59
60
61 == License
62
f8b5efc @jacius Project is now Ruby-SDL-FFI instead of FFI-SDL. Updated all files' co…
jacius authored
63 Ruby-SDL-FFI is licensed under the following terms (the "MIT License"):
c212f37 @jacius Added README.rdoc.
jacius authored
64
6f84fb5 @jacius Ruby-SDL-FFI 0.4 released.
jacius authored
65 Copyright (c) 2009-2011 John Croisant
c212f37 @jacius Added README.rdoc.
jacius authored
66
67 Permission is hereby granted, free of charge, to any person obtaining
68 a copy of this software and associated documentation files (the
69 "Software"), to deal in the Software without restriction, including
70 without limitation the rights to use, copy, modify, merge, publish,
71 distribute, sublicense, and/or sell copies of the Software, and to
72 permit persons to whom the Software is furnished to do so, subject to
73 the following conditions:
74
75 The above copyright notice and this permission notice shall be
76 included in all copies or substantial portions of the Software.
77
78 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
79 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
80 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
81 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
82 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
83 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
84 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.