win32/README.win32

   1 =begin
   2
   3 = How to build ruby using Visual C++
   4
   5 == Requirement
   6
   7 (1) Visual C++ 5.0 or later.
   8
   9     Note: if you want to build x64 or ia64 version, use native compiler for
  10           x64/ia64.
  11
  12 (2) Please set environment variable (({INCLUDE})), (({LIB})), (({PATH}))
  13     to run required commands properly from the command line.
  14
  15     Note: building ruby requires following commands.
  16      * nmake
  17      * cl
  18      * lib
  19      * dumpbin
  20
  21 (3) If you want to build from SVN source, following commands are required.
  22      * bison
  23      * sed
  24      * ruby 1.8
  25
  26 == How to compile and install
  27
  28 (1) Execute win32\configure.bat on your build directory.
  29     You can specify the target platform as an argument.
  30     For example, run `((%configure --target=i686-mswin32%))'
  31     You can also specify the install directory.
  32     For example, run `((%configure --prefix=<install_directory>%))'
  33     Default of the install directory is /usr .
  34
  35 (2) Change ((|RUBY_INSTALL_NAME|)) and ((|RUBY_SO_NAME|)) in (({Makefile}))
  36     if you want to change the name of the executable files.
  37     And add ((|RUBYW_INSTALL_NAME|)) to change the name of the
  38     executable without console window if also you want.
  39
  40 (3) Run `((%nmake%))'
  41
  42 (4) Run `((%nmake test%))'
  43
  44 (5) Run `((%nmake install%))'
  45
  46     This command will create following directories and install files onto them.
  47       * <install_directory>\bin
  48       * <install_directory>\lib
  49       * <install_directory>\lib\ruby
  50       * <install_directory>\lib\ruby\<MAJOR>.<MINOR>
  51       * <install_directory>\lib\ruby\<MAJOR>.<MINOR>\<PLATFORM>
  52       * <install_directory>\lib\ruby\site_ruby
  53       * <install_directory>\lib\ruby\site_ruby\<MAJOR>.<MINOR>
  54       * <install_directory>\lib\ruby\site_ruby\<MAJOR>.<MINOR>\<PLATFORM>
  55       * <install_directory>\man\man1
  56     If Ruby's version is `x.y.z', the ((|<MAJOR>|)) is `x' and the ((|<MINOR>|)) is `y'.
  57     The default ((|<PLATFORM>|)) is `(({i386-mswin32}))'.
  58
  59 == Icons
  60
  61 Any icon files(*.ico) in the build directory, directories specified with
  62 ((|icondirs|)) make variable and (({win32})) directory under the ruby
  63 source directory will be included in DLL or executable files, according
  64 to their base names.
  65     $(RUBY_INSTALL_NAME).ico or ruby.ico   --> $(RUBY_INSTALL_NAME).exe
  66     $(RUBYW_INSTALL_NAME).ico or rubyw.ico --> $(RUBYW_INSTALL_NAME).exe
  67     the others                             --> $(RUBY_SO_NAME).dll
  68
  69 Although no icons are distributed with the ruby source or in the official
  70 site, you can use anything you like. For example, followings are written
  71 in Japanese, but you can download at least.
  72
  73 * ((<URL:http://homepage1.nifty.com/a_nakata/ruby/>)) or
  74   ((<icon itself|URL:http://homepage1.nifty.com/a_nakata/ruby/RubyIcon.ico>))
  75
  76 == Build examples
  77
  78 * Build on the ruby source directory.
  79
  80   ex.)
  81     ruby source directory:  C:\ruby
  82     build directory:        C:\ruby
  83     install directory:      C:\usr\local
  84
  85     C:
  86     cd \ruby
  87     win32\configure --prefix=/usr/local
  88     nmake
  89     nmake test
  90     nmake install
  91
  92 * Build on the relative directory from the ruby source directory.
  93
  94   ex.)
  95     ruby source directory:  C:\ruby
  96     build directory:        C:\ruby\mswin32
  97     install directory:      C:\usr\local
  98
  99     C:
 100     cd \ruby
 101     mkdir mswin32
 102     cd mswin32
 103     ..\win32\configure --prefix=/usr/local
 104     nmake
 105     nmake test
 106     nmake install
 107
 108 * Build on the different drive.
 109
 110   ex.)
 111     ruby source directory:  C:\src\ruby
 112     build directory:        D:\build\ruby
 113     install directory:      C:\usr\local
 114
 115     D:
 116     cd D:\build\ruby
 117     C:\src\ruby\win32\configure --prefix=C:/usr/local
 118     nmake
 119     nmake test
 120     nmake install
 121
 122 * Build x64 version (requires native x64 VC++ compiler)
 123
 124   ex.)
 125     ruby source directory:  C:\ruby
 126     build directory:        C:\ruby
 127     install directory:      C:\usr\local
 128
 129     C:
 130     cd \ruby
 131     win32\configure --prefix=/usr/local --target=x64-mswin64
 132     nmake
 133     nmake test
 134     nmake install
 135
 136 == Bugs
 137
 138 You can ((*NOT*)) use a path name contains any white space characters as
 139 the ruby source directory, this restriction comes from the behavior of
 140 (({!INCLUDE})) directives of (({NMAKE})).
 141 ((- you may call it a bug. -))
 142
 143 =end