Update README for current toolchains and dead upstream links - #75
Open
tas50 wants to merge 1 commit into
Open
Conversation
The README had drifted badly from reality. Fixes: - gecode.org is offline (apex returns 521, www is NXDOMAIN). Point at github.com/Gecode/gecode instead. - ChefDK reached end of life; drop the download link, which 404s. - The standalone RubyInstaller DevKit is retired and its page 404s. Modern RubyInstaller2 bundles MSYS2, so document `ridk install`. - Windows 10 1803+ and Windows 11 ship bsdtar as System32\tar.exe, so the advice to go find a working tar is mostly obsolete. - Update opscode/* links to their chef/* equivalents. Also documents things that were never written down: - The build shells out to libtoolize, aclocal, autoheader, automake, autoconf and autoupdate, so autotools are required and not just a compiler. Adds a per-platform install table. - Homebrew installs GNU libtool as glibtoolize, but extconf.rb calls bare libtoolize, so a stock `brew install libtool` still fails on macOS. Documents the libexec/gnubin PATH fix. - USE_SYSTEM_GECODE is close to unusable now: Debian and Ubuntu ship Gecode 6.2.0 and Homebrew ships 6.4.0, and dep-selector needs 3.x. Two corrections: the concurrent job count is min(cores, 4) + 1, so up to five and not four, and the `rake native` example still referenced 1.3.0 rather than the current 1.3.5. Signed-off-by: Tim Smith <tsmith84@proton.me>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README had drifted a long way from reality, including several links that no longer resolve. Every link in the file was checked before editing.
Dead or moved links
gecode.orgwwwis NXDOMAINdownloads.chef.io/chef-dk/windows/rubyinstaller.org/add-ons/devkit/ridk installopscode/dep-selector,opscode/omnibus-chefchef/*equivalentsRequirements that were never documented
ext/libgecode3/extconf.rbshells out tolibtoolize,aclocal,autoheader,automake,autoconfandautoupdateon non-Windows platforms, so autotools are a hard requirement and not just a C++ compiler. The README previously said nothing about this. Adds a per-platform install table.glibtoolizeto avoid colliding with Apple's unrelatedlibtool, butextconf.rbinvokes barelibtoolize. A stockbrew install libtooltherefore still fails on macOS. Documents thelibexec/gnubinPATH fix.USE_SYSTEM_GECODEis close to unusable in practice now. Debian and Ubuntu ship Gecode 6.2.0 and Homebrew ships 6.4.0, while dep-selector needs 3.x, so the option is only realistic for someone who has built 3.7.3 themselves or is packaging inside a larger build such as Omnibus. Reframed accordingly rather than left as a generic "make sure it's version 3" warning.Corrections
make -jwas capped at 4.extconf.rbcomputesmin(cores, 4) + 1, so it is up to five jobs.rake nativeexample still referenced 1.3.0; the current version is 1.3.5.Additions
Note that the Development section links to
.github/workflows/ci.yml, which is added in a follow-up PR. That link will 404 until the CI PR lands.Issues Resolved
None filed; this is documentation drift found while reading through the repo.
Check List
Documentation-only change, so the test boxes do not apply. No code is touched.