search

ohai / ruby-sdl2

A Ruby wrapper for SDL 2.x
GNU Lesser General Public License v3.0
71 stars 16 forks source link

Broken link to "devkit" in README.md #26

Closed synthead closed 1 year ago

synthead commented 1 year ago

In README.md, the "devkit" link returns a 404:

Install

Before installing Ruby/SDL2, you need to install:

image

synthead commented 1 year ago

It looks like we want this link to go to https://rubyinstaller.org/add-ons/devkit.html. However, on this page, we see:

MSYS2-DevKit (only Ruby >= 2.4)

Stating with RubyInstaller-2.4 we’re no longer using our own DevKit compilation, but make use of MSYS2 for both building Ruby itself as well as building Ruby gems with C-extensions. It can be installed through the ridk install command, which is part of RubyInstaller-2.4. Alternatively a manual download and installation from MSYS2 is also possible. Dedicated DevKit (only Ruby < 2.4)

The RubyInstaller Development Kit is a toolkit that makes it easy to build and use native C/C++ extensions such as RDiscount and Nokogiri for Ruby on Windows. It is built on MSYS1, which is no longer maintained now. So you should upgrade to RubyInstaller-2.4 which makes use of MSYS2.

Simply download, double-click, choose an installation directory and run the Ruby install helper script and you’re ready to start using native Ruby extensions. For installation details check out the Development Kit wiki page.

Ruby 2.4.0 was released in 2016, and it's ancient. Most folks will probably be installing build dependencies for a newer Ruby version. Therefore, "installing the devkit," according to these instructions, is outdated for the most part. According to their documentation, ridk install will install the dependencies. Due to this, it is probably best to fix the link and simply tell the user to follow the upstream instructions :+1: