Skip to content

README: regenerate with the fixed generate_readme (binary packages, Homebrew trust, links) - #278

Merged
tkralphs merged 2 commits into
masterfrom
readme-fixes
Oct 19, 2026
Merged

tkralphs merged 2 commits into
masterfrom
readme-fixes

Conversation

@tkralphs

@tkralphs tkralphs commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

This regenerates the README with the fixed generate_readme of coin-or/coinbrew#109. It makes the same changes on master and on the latest stable branch.

  • Binary packages: Debian/Ubuntu: coinor-coinutils doesn't exist, so apt install failed; the package is coinor-libcoinutils-dev. Adds the MSYS2 package. The Homebrew instructions use only the coin-or-tools tap, with brew update and brew trust, which Homebrew 6.0 and later need (see Cbc#783). The conda command uses -c conda-forge.
  • Docker Hub: the link now goes to the public page of the image, instead of the owner's /repository/ page, which needs a login.
  • Doxygen: make doxygen-docs instead of make doxydoc, which doesn't exist in every build. The link to the online documentation uses https.
  • Typos: "aeasy", "PKG_CONFIG_PTH", "formum".
  • README workflow: adds .github/workflows/readme.yml, which calls the reusable workflow of Add a reusable workflow that regenerates and checks project READMEs coinbrew#110. It regenerates README.md when .coin-or/config.yml or .coin-or/generate_readme change, and every week. On pull requests that change README.md, it checks that the README wasn't edited by hand. The CI workflows now skip builds when only README.md, .coin-or/generate_readme or readme.yml change.

The README is generated from the coinbrew branch of #109. Until #109 and coin-or/coinbrew#110 are merged, the new README check fails, and regenerating the README with coinbrew master would undo these changes. Once both are merged, rerun the check.

🤖 Generated with Claude Code

tkralphs and others added 2 commits October 19, 2026 13:15
List only the binary packages that exist (now set in generate_readme
instead of being derived from the project name), the Homebrew tap with
brew trust (needed since Homebrew 6.0), and fix the Docker Hub, Doxygen,
and other links and typos. See coin-or/coinbrew#109.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add .github/workflows/readme.yml, which calls the reusable workflow of
coin-or/coinbrew#110: it regenerates README.md when .coin-or/config.yml
or .coin-or/generate_readme change (and weekly, to pick up changes of
coinbrew's scripts/generate_readme), and checks that pull requests
changing README.md do not edit it by hand. The build workflows ignore
changes of only README.md, .coin-or/generate_readme, and readme.yml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tkralphs
tkralphs merged commit 6e34dfd into master Oct 19, 2026
1 of 14 checks passed
@tkralphs
tkralphs deleted the readme-fixes branch October 19, 2026 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant