Skip to content

docs: update installation to single-command Homebrew and add formula update guide #279

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
paxcalpt merged 1 commit into from
Jan 30, 2026
Merged

docs: update installation to single-command Homebrew and add formula update guide #279

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
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,59 @@ docker run -v $(pwd):/workspace henriqueslab/rxiv-maker-base:latest rxiv pdf

---

## 🍺 Updating the Homebrew Formula

When releasing a new version of Rxiv-Maker, update the Homebrew formula:

### 1. Get Package Information from PyPI

```bash
VERSION=1.18.4 # Replace with new version
curl "https://pypi.org/pypi/rxiv-maker/$VERSION/json" | \
jq -r '.urls[] | select(.packagetype=="sdist") | "URL: \(.url)\nSHA256: \(.digests.sha256)"'
```

### 2. Update the Formula

Edit `homebrew-formulas/Formula/rxiv-maker.rb`:
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

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

Step 2 references editing homebrew-formulas/Formula/rxiv-maker.rb, but later steps assume you are already in the tap repo and use ./Formula/rxiv-maker.rb / git add Formula/rxiv-maker.rb. To avoid confusion, make the path consistent (e.g., refer to Formula/rxiv-maker.rb within the homebrew-formulas repo) and/or explicitly call out that this file lives in the separate HenriquesLab/homebrew-formulas repository.

Suggested change
Edit `homebrew-formulas/Formula/rxiv-maker.rb`:
In the `HenriquesLab/homebrew-formulas` tap repository, edit `Formula/rxiv-maker.rb`:

Copilot uses AI. Check for mistakes.
- Update the `url` line with the new URL
- Update the `sha256` line with the new hash

### 3. Test Locally

```bash
cd ~/GitHub/homebrew-formulas
brew uninstall rxiv-maker 2>/dev/null || true
brew install --build-from-source ./Formula/rxiv-maker.rb
brew test rxiv-maker
rxiv --version # Verify correct version
rxiv check-installation # Verify dependencies
```

### 4. Audit the Formula

```bash
brew audit --strict --online rxiv-maker
```

### 5. Commit and Push

```bash
git add Formula/rxiv-maker.rb
git commit -m "rxiv-maker: update to version $VERSION"
git push
```

### 6. Verify Installation

```bash
brew uninstall rxiv-maker
brew install henriqueslab/formulas/rxiv-maker
rxiv --version
```

---

## 🚀 Getting Started

### Development Environment Setup
Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@ Rxiv-Maker converts enhanced Markdown into professional PDFs with automated figu
<summary>🍎 <strong>macOS</strong> (Recommended - includes LaTeX automatically)</summary>

```bash
brew tap henriqueslab/formulas
brew install rxiv-maker
rxiv check-installation
brew install henriqueslab/formulas/rxiv-maker
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

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

The new macOS section switches to the fully-qualified brew install henriqueslab/formulas/rxiv-maker, but there are still docs in this repo that instruct users to brew tap henriqueslab/formulas (e.g., docs/ECOSYSTEM.md:103). This will leave readers with conflicting Homebrew instructions—please update the other references in this repo to match the new single-command install flow (or link to a single canonical installation doc).

Suggested change
brew install henriqueslab/formulas/rxiv-maker
brew tap henriqueslab/formulas
brew install rxiv-maker

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

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

The macOS install snippet no longer includes a post-install verification step (e.g., rxiv check-installation), while the Linux/WSL instructions still do. To keep the installation guidance consistent and to help users catch missing system dependencies early, consider adding the same verification command after the Homebrew install (even if the install itself is a single command).

Suggested change
brew install henriqueslab/formulas/rxiv-maker
brew install henriqueslab/formulas/rxiv-maker
rxiv check-installation

Copilot uses AI. Check for mistakes.
```

**Upgrade:**
**Updating:**
```bash
brew update
brew upgrade rxiv-maker
```

**Benefits:** Simple one-command installation, automatic dependency management (Python 3.13, LaTeX, git, gh), easy updates
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

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

The Benefits line hard-codes specific dependencies/versions (e.g., “Python 3.13”, “gh”). Since the package itself only declares a minimum Python version (see pyproject.toml requires-python) and gh is an optional integration (not required for core usage), this statement is likely to become inaccurate. Suggest rephrasing to avoid pinning to a specific Python minor version and to clarify optional vs required tools.

Suggested change
**Benefits:** Simple one-command installation, automatic dependency management (Python 3.13, LaTeX, git, gh), easy updates
**Benefits:** Simple one-command installation, automatic dependency management (Python, LaTeX, git; optional GitHub CLI (gh) integration), easy updates

Copilot uses AI. Check for mistakes.

> **📖 [Homebrew Formula](https://github.com/HenriquesLab/homebrew-formulas)** - Includes Python, LaTeX (MacTeX), and all dependencies

</details>
Expand Down