Skip to content

Add README.md for tool compatibility#4

Merged
hyperpolymath merged 1 commit intomainfrom
add-readme-md
Mar 11, 2026
Merged

Add README.md for tool compatibility#4
hyperpolymath merged 1 commit intomainfrom
add-readme-md

Conversation

@hyperpolymath
Copy link
Owner

Summary

  • Adds README.md at repo root (Markdown conversion of existing README.adoc)
  • Required by Glama and modelcontextprotocol/servers CI which check for README.md
  • Content is identical to README.adoc

🤖 Generated with Claude Code

Systems like Glama and modelcontextprotocol/servers CI require a
README.md at the repo root. This is a Markdown conversion of the
existing README.adoc with identical content.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@hyperpolymath hyperpolymath merged commit 1535fb3 into main Mar 11, 2026
6 checks passed
@hyperpolymath hyperpolymath deleted the add-readme-md branch March 11, 2026 02:13
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b055d8dd87

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

cd ../../ffi/zig && zig build

# Run tests
cd ffi/zig && zig build test

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Fix test step path in Quick Start

The quick-start sequence changes into ffi/zig on the previous line, so this step attempts to enter ffi/zig/ffi/zig, which does not exist; users following the README verbatim will fail before running tests. Either run zig build test from the current directory or cd back to the repo root before descending again.

Useful? React with 👍 / 👎.

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