@@ -69,7 +69,7 @@ === Advanced Install - The build and install tasks can be configured by providing certain 'flags' + The build and install tasks can be configured by providing certain commands to rake: * no-sdl-gfx:: do not build modules which depend on SDL_gfx @@ -78,17 +78,21 @@ * no-sdl-ttf:: do not build modules which depend on SDL_ttf * no-opengl:: do not build modules which depend on OpenGL - * no-sdl-config:: do not guess compiler flags using `sdl-config' + * no-sdl-config:: do not guess compiler/linker flags using `sdl-config' * debug:: build modules with debbugging flags enabled * verbose:: display the build commands as they are run - Additionally, the build process respects certain environmental variables: + Additionally, the build process respects certain environmental variables. + In particular, CFLAGS and LDFLAGS are important for users compiling with + the no-sdl-config command. + * CC:: C compiler command * CFLAGS:: flags passed to the C compiler + * LDSHARED:: linker command * LDFLAGS:: flags passed to the linker - * RUBYARCHDIR:: directory to install platform-specific compiled extensions - * RUBYLIBDIR:: directory to install platform-independent interpreted libs + * RUBYARCHDIR:: where to install platform-specific compiled extensions + * RUBYLIBDIR:: where to install platform-independent interpreted libs IMPORTANT: if you are missing any optional SDL_* libraries, you must specify "no-*" flags for those libraries. For example, if you don't have SDL_gfx: README @@ -49,15 +49,11 @@ In order to use Rubygame applications on Mac OS X, you must use a special wrappe == Installing Rubygame 1. {Download and unpack Rubygame}[https://sourceforge.net/project/showfiles.php?group_id=172781]. -2. (For Rubygame-1.1.0) From the rubygame directory: - - sudo ruby setup.rb all - -3. (For Rubygame-2.0.0) From the rubygame directory: +2. From within the rubygame directory: sudo rake install -4. Please refer to the README file for options that you can pass to setup.rb +3. Please refer to the README file for options that you can pass to setup.rb or rake (depending on your version of Rubygame) == Running an application doc/macosx_install.rdoc @@ -96,19 +96,9 @@ the libraries. set LINK_FLAGS=-L \windows\system32 -lSDL set LIBRUBYARG_SHARED=-L \ruby\bin -lmsvcrt-ruby18 - set RUBYGAME_CONFIG=--no-sdl-config - The -L parameter for LIBRUBYARG_SHARED may be different if you installed Ruby to a path other than C:/ruby. -IMPORTANT: If you are missing an optional library (such as SDL_gfx), you need -to add some extra flags on to the 'RUBYGAME_CONFIG=...' line. The flags you -must add are of the style '--no-????' (without quotes), where ???? is the -name of the missing library, dropping the 'SDL_' from in front. So, if you -don't have SDL_gfx, the last line of your envsetup.bat should be this: - - set RUBYGAME_CONFIG=--no-sdl-config --no-gfx - == Step 4: Compile and install Rubygame Open a command prompt and navigate to the root of your Rubygame source @@ -117,8 +107,17 @@ directory. Type: envsetup.bat rake install -Congratulations! If all goes well, you have built and installed Rubygame. +IMPORTANT: If you are missing an optional library (such as SDL_gfx), you must +disable optional features by passing a "no-???" command to rake before the word +"install". For example, to disable features that depend on SDL_gfx, you would +type this instead of the above: + + envsetup.bat + rake no-gfx install + +If all goes well, you have built and installed Rubygame. Try to execute <code>require 'rubygame'</code> in an irb session and run the provided samples to ensure that everything is acceptable. -(Thanks to Ash Wilson (smashwilson) for contributing these instructions.) +(Thanks to Ash Wilson (smashwilson) for contributing the original version of +these instructions.) doc/windows_install.rdoc 00d658f73bb57c8878db5f42f44e14f92d876757 John Croisant jacius@gmail.com http://github.com/jacius/rubygame/commit/84046b4def8e298674e472dc7bb143f357f66865 84046b4def8e298674e472dc7bb143f357f66865 2007-12-19T10:54:56-08:00 2007-12-19T10:54:56-08:00 Updated install instructions 83bdd3bd7e022208250370365d8dbc68bcded44e John Croisant jacius@gmail.com