|
4 | 4 |
|
5 | 5 |  |
6 | 6 |  |
7 | | - |
| 7 | + |
| 8 | + |
8 | 9 |
|
9 | 10 | ## What is this? |
10 | 11 |
|
@@ -102,21 +103,48 @@ graph LR |
102 | 103 |
|
103 | 104 | ## Quick Start |
104 | 105 |
|
| 106 | +### Install (pick one) |
| 107 | + |
105 | 108 | ```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 |
108 | 118 | ./scripts/install.sh |
109 | 119 | ``` |
110 | 120 |
|
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 | +``` |
112 | 128 |
|
113 | | -For Ansible or CI (no interactive prompts): |
| 129 | +### Optional extras |
114 | 130 |
|
115 | 131 | ```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 |
117 | 136 | ``` |
118 | 137 |
|
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 | +``` |
120 | 148 |
|
121 | 149 | Then run the interactive setup wizard: |
122 | 150 |
|
|
0 commit comments