Skip to content

Document T3 Code install methods#1564

Merged
juliusmarminge merged 3 commits intomainfrom
t3code/readme-install-methods
Mar 30, 2026
Merged

Document T3 Code install methods#1564
juliusmarminge merged 3 commits intomainfrom
t3code/readme-install-methods

Conversation

@juliusmarminge
Copy link
Copy Markdown
Member

@juliusmarminge juliusmarminge commented Mar 30, 2026

Summary

  • Clarifies installation options in the README.
  • Adds a quick run-without-installing path using npx t3.
  • Documents desktop install methods for Windows (winget), macOS (Homebrew), and Arch Linux (AUR), with links to the relevant package references.

Testing

  • Not run (README-only change).
  • Not run: bun fmt
  • Not run: bun lint
  • Not run: bun typecheck

Note

Low Risk
README-only documentation update; no runtime or behavior changes.

Overview
Updates README.md by replacing the old “How to use” section with a structured Installation guide.

Documents a run-without-installing path via npx t3 and adds desktop installation options including direct GitHub Releases download plus platform-specific package manager instructions for Windows (winget), macOS (Homebrew cask), and Arch Linux (AUR), with reference links.

Written by Cursor Bugbot for commit bdfea72. This will update automatically on new commits. Configure here.

Note

Document T3 Code installation methods in README

Reworks the usage section in README.md into a structured 'Installation' section covering all supported install methods.

  • Retains the npx t3 run-without-installing option as a subsection
  • Adds a 'Desktop app' section with a direct GitHub releases download link
  • Documents platform-specific package manager installs: winget (Windows), Homebrew cask (macOS), and AUR (Arch Linux), each with the relevant command and reference link

Macroscope summarized bdfea72.

- Split the install section into run-without-install and desktop app methods
- Add platform-specific install commands and package references
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0fca9073-e040-4216-8fda-8d6c94483429

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch t3code/readme-install-methods

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added vouch:trusted PR author is trusted by repo permissions or the VOUCHED list. size:M 30-99 changed lines (additions + deletions). labels Mar 30, 2026
- Split download, winget, Homebrew, and AUR installs into their own sections
- Add package references for each platform
@juliusmarminge juliusmarminge merged commit 145ddfc into main Mar 30, 2026
11 checks passed
@juliusmarminge juliusmarminge deleted the t3code/readme-install-methods branch March 30, 2026 05:33
aaditagrawal added a commit to aaditagrawal/t3code that referenced this pull request Mar 30, 2026
Integrates upstream changes including:

- Refactor terminal manager onto Effect runtime (pingdotgg#1525)
- Refactor web orchestration sync to incremental events and
  isolated recovery (pingdotgg#1560)
- Remove redundant add-project cancel button (pingdotgg#1302)
- README documentation updates (pingdotgg#1406, pingdotgg#1564, pingdotgg#1565)

Conflict resolution across 8 files: adopted upstream's incremental
event store architecture, terminal Effect runtime, and batched
orchestration effects while preserving fork's multi-provider state.
Chrono-byte pushed a commit to Chrono-byte/t3code that referenced this pull request Mar 31, 2026
xddinside referenced this pull request in xddinside/t3code Apr 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 changed lines (additions + deletions). vouch:trusted PR author is trusted by repo permissions or the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant