From 3c303317e180ee1027cbe37a5ad4779ff6b4d915 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 22 Jan 2026 14:47:23 -0500 Subject: [PATCH] docs: move system requirements section under installation Move the System Requirements section to appear directly after the quick install bash script, making it more discoverable for new users. Also wrap OS-specific installation instructions in collapsible details elements for better readability. Closes #15 Co-Authored-By: Claude Opus 4.5 --- README.md | 98 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 55 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 9fb3227..c1d9b5a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,61 @@ curl -fsSL https://raw.githubusercontent.com/pmarsceill/mapcli/main/install.sh | This installs both `map` and `mapd` to `~/.local/bin`. Make sure this directory is in your PATH. +### System Requirements + +MAP requires the following tools to be installed and available in your PATH: + +| Dependency | Required For | Version | +|------------|--------------|---------| +| **git** | Worktree isolation | 2.15+ (worktree support) | +| **tmux** | Agent session management | Any recent version | +| **claude** | Claude Code agents | Latest (optional if only using Codex) | +| **codex** | OpenAI Codex agents | Latest (optional if only using Claude) | + +At least one of `claude` or `codex` must be installed depending on which agent type you want to use. + +**Installing Dependencies:** + +
+macOS (Homebrew) + +```bash +brew install git tmux +# Claude CLI: https://docs.anthropic.com/en/docs/claude-code +# Codex CLI: https://github.com/openai/codex +``` +
+ +
+Ubuntu/Debian + +```bash +sudo apt update && sudo apt install git tmux +# Claude CLI: https://docs.anthropic.com/en/docs/claude-code +# Codex CLI: https://github.com/openai/codex +``` +
+ +
+Fedora/RHEL + +```bash +sudo dnf install git tmux +# Claude CLI: https://docs.anthropic.com/en/docs/claude-code +# Codex CLI: https://github.com/openai/codex +``` +
+ +
+Arch Linux + +```bash +sudo pacman -S git tmux +# Claude CLI: https://docs.anthropic.com/en/docs/claude-code +# Codex CLI: https://github.com/openai/codex +``` +
+ **Manual installation:** Download the latest release from the [releases page](https://github.com/pmarsceill/mapcli/releases) and extract the binaries to a directory in your PATH. @@ -394,49 +449,6 @@ mapcli/ | `-f, --foreground` | `false` | Run daemon in foreground | | `-d, --data-dir` | `~/.mapd` | Data directory for SQLite | -## System Requirements - -MAP requires the following tools to be installed and available in your PATH: - -| Dependency | Required For | Version | -|------------|--------------|---------| -| **git** | Worktree isolation | 2.15+ (worktree support) | -| **tmux** | Agent session management | Any recent version | -| **claude** | Claude Code agents | Latest (optional if only using Codex) | -| **codex** | OpenAI Codex agents | Latest (optional if only using Claude) | - -At least one of `claude` or `codex` must be installed depending on which agent type you want to use. - -### Installing Dependencies - -**macOS (Homebrew):** -```bash -brew install git tmux -# Claude CLI: https://docs.anthropic.com/en/docs/claude-code -# Codex CLI: https://github.com/openai/codex -``` - -**Ubuntu/Debian:** -```bash -sudo apt update && sudo apt install git tmux -# Claude CLI: https://docs.anthropic.com/en/docs/claude-code -# Codex CLI: https://github.com/openai/codex -``` - -**Fedora/RHEL:** -```bash -sudo dnf install git tmux -# Claude CLI: https://docs.anthropic.com/en/docs/claude-code -# Codex CLI: https://github.com/openai/codex -``` - -**Arch Linux:** -```bash -sudo pacman -S git tmux -# Claude CLI: https://docs.anthropic.com/en/docs/claude-code -# Codex CLI: https://github.com/openai/codex -``` - ## Development ### Prerequisites