External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve README installation instructions for clarity (#150)

Browse Source 
docs: revise installation instructions in README.md to clarify the two-step process for SuperClaude setup, including detailed steps for package installation and running the installer.
This commit is contained in:
Jacob
2025-07-16 17:38:57 +10:00
committed by GitHub
parent 67585af9a5
commit decfd2be6f
1 changed files with 24 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -91,25 +91,25 @@ This is because v3 has a different structure and the old files can cause conflic
## Installation 📦 ## Installation 📦
### Quick Start SuperClaude installation is a **two-step process**:
1. First install the Python package
2. Then run the installer to set up Claude Code integration
### Step 1: Install the Package
**Option A: From PyPI (Recommended)**
```bash ```bash
pip install SuperClaude pip install SuperClaude
#Install with python-pip
``` ```
### Install via Git
**Option B: From Source**
```bash ```bash
# Clone the repo
git clone https://github.com/NomenAK/SuperClaude.git git clone https://github.com/NomenAK/SuperClaude.git
cd SuperClaude cd SuperClaude
# Install with our unified CLI
pip install . pip install .
# That's it! 🎉
``` ```
**Missing Python?** Install Python 3.7+ first:
**Missing Python?**
```bash ```bash
# Linux (Ubuntu/Debian) # Linux (Ubuntu/Debian)
sudo apt update && sudo apt install python3 python3-pip sudo apt update && sudo apt install python3 python3-pip
@@ -121,22 +121,28 @@ brew install python3
# Download from https://python.org/downloads/ # Download from https://python.org/downloads/
``` ```
### Other Installation Options ### Step 2: Run the Installer
After installing the package, run the SuperClaude installer to configure Claude Code:
```bash ```bash
# Quick setup (recommended for most users)
python3 SuperClaude install
# Interactive selection (choose components)
python3 SuperClaude install --interactive
# Minimal install (just core framework) # Minimal install (just core framework)
python3 SuperClaude install --minimal python3 SuperClaude install --minimal
# Developer setup (everything) # Developer setup (everything included)
python3 SuperClaude install --profile developer python3 SuperClaude install --profile developer
# Interactive selection # See all available options
python3 SuperClaude install python3 SuperClaude install --help
# See what's available
python3 SuperClaude install --list-components
``` ```
The installer handles everything: framework files, MCP servers, and Claude Code configuration. **That's it! 🎉** The installer handles everything: framework files, MCP servers, and Claude Code configuration.
## How It Works 🔄 ## How It Works 🔄