Improve documentation on contributing to Ruby

co-authored-by: Peter Zhu <peter@peterzhu.ca>
co-authored-by: Stan Lo <stan001212@gmail.com>

1 files changed, 3 insertions, 90 deletions

diff --git a/README.md b/README.md
index a4a2ef1c91..0350ec3fb2 100644
--- a/README.md
+++ b/README.md
@@ -74,107 +74,20 @@ in the mail body (not subject) to the address [ruby-talk-request@ruby-lang.org].
 
 [ruby-talk-request@ruby-lang.org]: mailto:ruby-talk-request@ruby-lang.org?subject=Join%20Ruby%20Mailing%20List&body=subscribe
 
-## Requirements to build from repository
-
-1. GNU or BSD make
-2. C99 compiler
-3. autoconf 2.67 or higher
-4. automake 1.15 or higher
-5. bison 2.3 or higher
-6. Ruby 2.2 or higher
-
-When building from a released version, only a C99 compiler and GNU or BSD make
-is required.
-
-## How to compile and install
-
-1. If you want to use Microsoft Visual C++ to compile Ruby, read
-   [win32/README.win32](rdoc-ref:win32/README.win32) instead of this document.
-
-2. Run `./autogen.sh` to generate configure, when you build the source checked
-   out from the Git repository.
-
-3. Run `./configure`, which will generate `config.h` and `Makefile`.
-
-    Some C compiler flags may be added by default depending on your
-    environment. Specify `optflags=..` and `warnflags=..` as necessary to
-    override them.
-
-4. Edit `include/ruby/defines.h` if you need. Usually this step will not be needed.
-
-5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
-
-    This step is only necessary if you want to link modules statically.
-
-    If you don't want to compile dynamic extensions (probably on architectures
-    which do not allow dynamic loading), remove comment mark from the line
-    "`#option nodynamic`" in `ext/Setup`.
-
-    Usually this step will not be needed.
-
-6. Run `make`.
-
-    * On Mac, set RUBY\_CODESIGN environment variable with a signing identity.
-      It uses the identity to sign `ruby` binary. See also codesign(1).
-
-7. Optionally, run '`make check`' to check whether the compiled Ruby
-   interpreter works well. If you see the message "`check succeeded`", your
-   Ruby works as it should (hopefully).
-
-8. Run '`make install`'.
-
-    This command will create the following directories and install files into
-    them.
-
-    *   `${DESTDIR}${prefix}/bin`
-    *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}`
-    *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
-    *   `${DESTDIR}${prefix}/lib`
-    *   `${DESTDIR}${prefix}/lib/ruby`
-    *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}`
-    *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
-    *   `${DESTDIR}${prefix}/lib/ruby/site_ruby`
-    *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}`
-    *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
-    *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby`
-    *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}`
-    *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
-    *   `${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}`
-    *   `${DESTDIR}${prefix}/share/man/man1`
-    *   `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system`
-
-    If Ruby's API version is '*x.y.z*', the `${MAJOR}` is '*x*', the
-    `${MINOR}` is '*y*', and the `${TEENY}` is '*z*'.
-
-    **NOTE**: teeny of the API version may be different from one of Ruby's
-    program version
-
-    You may have to be a super user to install Ruby.
-
-If you fail to compile Ruby, please send the detailed error report with the
-error log and machine/OS type, to help others.
-
-Some extension libraries may not get compiled because of lack of necessary
-external libraries and/or headers. You will need to run '`make distclean-ext`'
-to remove old configuration after installing them in such a case.
-
 ## Copying
 
 See the file [COPYING](rdoc-ref:COPYING).
 
 ## Feedback
 
-Questions about the Ruby language can be asked on the [Ruby-Talk] mailing list
+Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list
 or on websites like https://stackoverflow.com.
 
-Bugs should be reported at https://bugs.ruby-lang.org. Read [HowToReport] for more information.
-
-[Ruby-Talk]: https://www.ruby-lang.org/en/community/mailing-lists
-[HowToReport]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport
+Bugs should be reported at https://bugs.ruby-lang.org. Read ["Reporting Issues"](https://docs.ruby-lang.org/en/master/reporting_issues_md.html) for more information.
 
 ## Contributing
 
-See the file [CONTRIBUTING.md](rdoc-ref:CONTRIBUTING)
+See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions.
 
 ## The Author