1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README.win32: reformat as RDoc

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66983 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2019-02-01 13:40:10 +00:00
parent 1f34da3709
commit adbdbff2df
1 changed files with 35 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
win32/README.win32
View File

@ -1,62 +1,60 @@
=begin
= How to build ruby using Visual C++ = How to build ruby using Visual C++
== Requirement == Requirement
(1) Windows XP or later. 1. Windows XP or later.
(2) Visual C++ 6.0 or later. (strongly recommended VC++ 10 or later) 2. Visual C++ 6.0 or later. (strongly recommended VC++ 10 or later)
Note: if you want to build x64 or ia64 version, use native compiler for Note:: if you want to build x64 or ia64 version, use native compiler for
x64/ia64. x64/ia64.
(3) Please set environment variable (({INCLUDE})), (({LIB})), (({PATH})) 3. Please set environment variable +INCLUDE+, +LIB+, +PATH+
to run required commands properly from the command line. to run required commands properly from the command line.
Note: building ruby requires following commands. Note:: building ruby requires following commands.
* nmake * nmake
* cl * cl
* lib * lib
* dumpbin * dumpbin
(4) If you want to build from SVN source, following commands are required. 4. If you want to build from SVN source, following commands are required.
* bison * bison
* patch * patch
* sed * sed
* ruby 1.8 or later * ruby 1.8 or later
(5) Enable Command Extension of your command line. It's the default behavior 5. Enable Command Extension of your command line. It's the default behavior
of cmd.exe. If you want to enable it explicitly, run cmd.exe with /E:ON of +cmd.exe+. If you want to enable it explicitly, run +cmd.exe+ with
option. <tt>/E:ON</tt> option.
== How to compile and install == How to compile and install
(1) Execute win32\configure.bat on your build directory. 1. Execute win32\configure.bat on your build directory.
You can specify the target platform as an argument. You can specify the target platform as an argument.
For example, run `((%configure --target=i686-mswin32%))' For example, run `<tt>configure --target=i686-mswin32</tt>'
You can also specify the install directory. You can also specify the install directory.
For example, run `((%configure --prefix=<install_directory>%))' For example, run `<tt>configure --prefix=<install_directory></tt>'
Default of the install directory is /usr . Default of the install directory is /usr .
The default ((|<PLATFORM>|)) is `(({i386-mswin32}))'. The default _PLATFORM_ is `+i386-mswin32+'.
(2) Change ((|RUBY_INSTALL_NAME|)) and ((|RUBY_SO_NAME|)) in (({Makefile})) 2. Change _RUBY_INSTALL_NAME_ and _RUBY_SO_NAME_ in +Makefile+
if you want to change the name of the executable files. if you want to change the name of the executable files.
And add ((|RUBYW_INSTALL_NAME|)) to change the name of the And add _RUBYW_INSTALL_NAME_ to change the name of the
executable without console window if also you want. executable without console window if also you want.
(3) Run `((%nmake up%))' if you are building from SVN source. 3. Run `<tt>nmake up</tt>' if you are building from SVN source.
(4) Run `((%nmake%))' 4. Run `<tt>nmake</tt>'
(5) Run `((%nmake exam%))' 5. Run `<tt>nmake exam</tt>'
(6) Run `((%nmake install%))' 6. Run `<tt>nmake install</tt>'
== Icons == Icons
Any icon files(*.ico) in the build directory, directories specified with Any icon files(*.ico) in the build directory, directories specified with
((|icondirs|)) make variable and (({win32})) directory under the ruby _icondirs_ make variable and +win32+ directory under the ruby
source directory will be included in DLL or executable files, according source directory will be included in DLL or executable files, according
to their base names. to their base names.
$(RUBY_INSTALL_NAME).ico or ruby.ico --> $(RUBY_INSTALL_NAME).exe $(RUBY_INSTALL_NAME).ico or ruby.ico --> $(RUBY_INSTALL_NAME).exe
@ -67,8 +65,8 @@ Although no icons are distributed with the ruby source or in the official
site, you can use anything you like. For example, followings are written site, you can use anything you like. For example, followings are written
in Japanese, but you can download at least. in Japanese, but you can download at least.
* ((<URL:http://homepage1.nifty.com/a_nakata/ruby/>)) or * http://homepage1.nifty.com/a_nakata/ruby/ or
((<icon itself|URL:http://homepage1.nifty.com/a_nakata/ruby/RubyIcon.ico>)) {icon itself}[http://homepage1.nifty.com/a_nakata/ruby/RubyIcon.ico]
== Build examples == Build examples
@ -132,13 +130,10 @@ in Japanese, but you can download at least.
== Bugs == Bugs
You can ((*NOT*)) use a path name that contains any white space characters as You can *NOT* use a path name that contains any white space characters as
the ruby source directory, this restriction comes from the behavior of the ruby source directory, this restriction comes from the behavior of
(({!INCLUDE})) directives of (({NMAKE})). <code>!INCLUDE</code> directives of +NMAKE+.
((- you may call it a bug. -))
You can build ruby in any directory including the source directory, You can build ruby in any directory including the source directory,
except (({win32})) directory in the source directory. except +win32+ directory in the source directory.
This is restriction originating in the path search method of (({NMAKE})). This is restriction originating in the path search method of +NMAKE+.
=end