Skip to content

Commit 0980fdb

Browse files
docs: update README with PyPI/Homebrew install, fix repo URLs to lowercase
- Add PyPI badge, pip install and brew install to Quick Start - "3 Steps to Start" section: setup, web, help - Optional extras section with pip install examples - Update all repo URLs from Socratic-Study-Mentor to socratic-study-mentor Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2ea73f4 commit 0980fdb

2 files changed

Lines changed: 39 additions & 11 deletions

File tree

README.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
55
![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)
66
![License MIT](https://img.shields.io/badge/license-MIT-green)
7-
![CI](https://github.com/NetDevAutomate/Socratic-Study-Mentor/actions/workflows/ci.yml/badge.svg)
7+
![PyPI](https://img.shields.io/pypi/v/studyctl)
8+
![CI](https://github.com/NetDevAutomate/socratic-study-mentor/actions/workflows/ci.yml/badge.svg)
89

910
## What is this?
1011

@@ -102,21 +103,48 @@ graph LR
102103

103104
## Quick Start
104105

106+
### Install (pick one)
107+
105108
```bash
106-
git clone https://github.com/NetDevAutomate/Socratic-Study-Mentor.git
107-
cd Socratic-Study-Mentor
109+
# PyPI (recommended)
110+
pip install studyctl
111+
112+
# Homebrew (macOS)
113+
brew install NetDevAutomate/studyctl/studyctl
114+
115+
# From source
116+
git clone https://github.com/NetDevAutomate/socratic-study-mentor.git
117+
cd socratic-study-mentor
108118
./scripts/install.sh
109119
```
110120

111-
This installs packages, registers CLI tools globally (`studyctl`, `session-export`, `session-sync`, etc.), sets up agent definitions for any detected AI tools, and optionally downloads the voice model for TTS support.
121+
### 3 Steps to Start
122+
123+
```bash
124+
studyctl setup # Interactive configuration wizard
125+
studyctl web # Launch the study web app
126+
studyctl --help # See all commands
127+
```
112128

113-
For Ansible or CI (no interactive prompts):
129+
### Optional extras
114130

115131
```bash
116-
./scripts/install.sh --non-interactive
132+
pip install 'studyctl[all]' # Everything (web, tui, content, mcp, notebooklm)
133+
pip install 'studyctl[web]' # FastAPI web UI
134+
pip install 'studyctl[content]' # PDF splitting + NotebookLM content pipeline
135+
pip install 'studyctl[mcp]' # MCP server for AI coding assistants
117136
```
118137

119-
Other modes: `--tools-only` (just CLI tools), `--agents-only` (just agent definitions).
138+
### From source (advanced)
139+
140+
The install script registers CLI tools globally, sets up agent definitions for any detected AI tools, and optionally downloads the voice model for TTS support.
141+
142+
```bash
143+
./scripts/install.sh # Full install (interactive)
144+
./scripts/install.sh --non-interactive # For Ansible/CI
145+
./scripts/install.sh --tools-only # Just CLI tools
146+
./scripts/install.sh --agents-only # Just agent definitions
147+
```
120148

121149
Then run the interactive setup wizard:
122150

packages/studyctl/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ studyctl = "studyctl.cli:cli"
3535
studyctl-mcp = "studyctl.mcp.server:main"
3636

3737
[project.urls]
38-
Homepage = "https://github.com/NetDevAutomate/Socratic-Study-Mentor"
39-
Repository = "https://github.com/NetDevAutomate/Socratic-Study-Mentor"
40-
Issues = "https://github.com/NetDevAutomate/Socratic-Study-Mentor/issues"
41-
Documentation = "https://github.com/NetDevAutomate/Socratic-Study-Mentor/tree/main/docs"
38+
Homepage = "https://github.com/NetDevAutomate/socratic-study-mentor"
39+
Repository = "https://github.com/NetDevAutomate/socratic-study-mentor"
40+
Issues = "https://github.com/NetDevAutomate/socratic-study-mentor/issues"
41+
Documentation = "https://github.com/NetDevAutomate/socratic-study-mentor/tree/main/docs"
4242

4343
[build-system]
4444
requires = ["hatchling"]

0 commit comments

Comments
 (0)