Skip to content

Expand README with comprehensive documentation - #17

Merged
tuler merged 2 commits into
mainfrom
claude/improve-readme-034qh2
Aug 17, 2026
Merged

tuler merged 2 commits into
mainfrom
claude/improve-readme-034qh2

Conversation

@tuler

@tuler tuler commented Aug 17, 2026

Copy link
Copy Markdown
Member

Summary

This PR significantly expands the README.md with comprehensive documentation for the Cartesi Homebrew Tap, including installation instructions, formula descriptions, usage examples, platform support information, and contribution guidelines.

Key Changes

  • Added detailed introduction explaining what the tap provides
  • Added "Installation" section with multiple installation methods
  • Added "Formulae" section with a table describing all available formulae and their purposes
  • Added "Usage" section with practical examples for installing and running the machine and CLI
  • Added "Supported platforms" section documenting prebuilt bottle availability and build requirements
  • Added "Updating and uninstalling" section with common commands
  • Added "Contributing" section with detailed workflow for formula changes and testing procedures
  • Added "Troubleshooting" section addressing common issues
  • Reorganized "More information" section at the end with links to documentation and GitHub

Notable Details

  • Documentation is structured to guide users from basic installation through advanced contribution workflows
  • Includes specific examples of common commands users will run
  • Explains the metapackage concept and how images are symlinked
  • Provides clear instructions for local testing before opening PRs
  • Clarifies the automated bottle building and publishing workflow

https://claude.ai/code/session_0196kM7tj5xrJXfaPkjhqesk

claude added 2 commits August 17, 2026 22:06
Document what the tap ships, how the metapackage and image formulae fit
together, which platforms have bottles, and the pr-pull based release
flow used by the CI workflows.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0196kM7tj5xrJXfaPkjhqesk
Homebrew 6.0.0 requires third-party taps to be explicitly trusted before
their code is evaluated, so 'brew tap cartesi/tap' on its own leaves the
formulae ignored. Add the trust step to the install instructions, explain
the per-formula alternative, and cover the warning in troubleshooting.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0196kM7tj5xrJXfaPkjhqesk
@tuler
tuler merged commit 6c81f3e into main Aug 17, 2026
2 checks passed
@tuler
tuler deleted the claude/improve-readme-034qh2 branch August 17, 2026 22:20
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.

2 participants