Skip to content

docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 1 commit into from
Jun 25, 2026
Merged

docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 0 additions & 75 deletions README.adoc
View file
Open in desktop

This file was deleted.

63 changes: 63 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->

**Homebrew tap for hyperpolymath CLI tools.**

[![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/homebrew-tap)
[![License: MPL-2.0](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](https://opensource.org/licenses/MPL-2.0) <embed
src="https://api.thegreenwebfoundation.org/greencheckimage/github.com"
data-link="https://www.thegreenwebfoundation.org/green-web-check/?url=github.com" />
![Homebrew tap](https://img.shields.io/badge/homebrew-tap-yellow.svg)

# What this is

This is the official [Homebrew](https://brew.sh) tap for hyperpolymath
tools. It lets macOS (and Linux) users install hyperpolymath binaries
via `brew` without manual compilation.

# Install

```bash
# Add the tap once
brew tap hyperpolymath/tap

# Install BoJ server (cartridge-based MCP server)
brew install boj-server
```

# Available formulae

| Formula | Installs | Source |
|----|----|----|
| `boj-server` | Bundle of Joy MCP server — 53 formally verified domain cartridges | [hyperpolymath/boj-server](https://github.com/hyperpolymath/boj-server) |

# Repository layout

| Path | What it contains |
|----|----|
| `Formula/boj-server.rb` | Homebrew formula: install recipe, test block, and dependency declarations |
| `contractiles/` | Contractile validation rules (RSR standard) |

# Notes for maintainers

The `boj-server.rb` formula contains a `sha256` `"UPDATE_ON_RELEASE"`
placeholder that must be replaced with the actual tarball SHA-256 when
cutting a release. Run `sha256sum` `<tarball>` or use `brew` `fetch`
`--build-from-source` to obtain it.

See <a href="EXPLAINME.adoc" class="adoc">EXPLAINME</a> for the full
implementation map.

# License

This project is licensed under the Mozilla Public License, v. 2.0. See
the `LICENSE` file for details.

SPDX-License-Identifier: CC-BY-SA-4.0

# Author

Jonathan D.A. Jewell\
[j.d.a.jewell@open.ac](j.d.a.jewell@open.ac).uk
Loading