ruby-changes:54766
From: nobu <ko1@a...>
Date: Fri, 1 Feb 2019 22:40:15 +0900 (JST)
Subject: [ruby-changes:54766] nobu:r66983 (trunk): README.win32: reformat as RDoc
nobu 2019-02-01 22:40:10 +0900 (Fri, 01 Feb 2019) New Revision: 66983 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=66983 Log: README.win32: reformat as RDoc Modified files: trunk/win32/README.win32 Index: win32/README.win32 =================================================================== --- win32/README.win32 (revision 66982) +++ win32/README.win32 (revision 66983) @@ -1,62 +1,60 @@ https://github.com/ruby/ruby/blob/trunk/win32/README.win32#L1 -=begin - = How to build ruby using Visual C++ == 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 - x64/ia64. + Note:: if you want to build x64 or ia64 version, use native compiler for + 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. - Note: building ruby requires following commands. - * nmake - * cl - * lib - * dumpbin - -(4) If you want to build from SVN source, following commands are required. - * bison - * patch - * sed - * ruby 1.8 or later - -(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 - option. + Note:: building ruby requires following commands. + * nmake + * cl + * lib + * dumpbin + +4. If you want to build from SVN source, following commands are required. + * bison + * patch + * sed + * ruby 1.8 or later + +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 + <tt>/E:ON</tt> option. == 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. - For example, run `((%configure --target=i686-mswin32%))' + For example, run `<tt>configure --target=i686-mswin32</tt>' 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 . - 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. - 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. -(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 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 to their base names. $(RUBY_INSTALL_NAME).ico or ruby.ico --> $(RUBY_INSTALL_NAME).exe @@ -67,8 +65,8 @@ Although no icons are distributed with t https://github.com/ruby/ruby/blob/trunk/win32/README.win32#L65 site, you can use anything you like. For example, followings are written in Japanese, but you can download at least. -* ((<URL:http://homepage1.nifty.com/a_nakata/ruby/>)) or - ((<icon itself|URL:http://homepage1.nifty.com/a_nakata/ruby/RubyIcon.ico>)) +* http://homepage1.nifty.com/a_nakata/ruby/ or + {icon itself}[http://homepage1.nifty.com/a_nakata/ruby/RubyIcon.ico] == Build examples @@ -132,13 +130,10 @@ in Japanese, but you can download at lea https://github.com/ruby/ruby/blob/trunk/win32/README.win32#L130 == 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 -(({!INCLUDE})) directives of (({NMAKE})). -((- you may call it a bug. -)) +<code>!INCLUDE</code> directives of +NMAKE+. You can build ruby in any directory including the source directory, -except (({win32})) directory in the source directory. -This is restriction originating in the path search method of (({NMAKE})). - -=end +except +win32+ directory in the source directory. +This is restriction originating in the path search method of +NMAKE+. -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/