Skip to content

Commit 8d6550b

Browse files
lijunliu-ghclaude
andcommitted
docs: align test count in README and document .env.example
- Update README test comment from "400+ tests" to "408 tests" to match badge - Add grouped comments to .env.example explaining each variable's purpose and whether it is required or optional Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a40281b commit 8d6550b

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

.env.example

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1+
# ── LLM Provider (at least one required) ──────────────────────────
2+
# OpenAI or any OpenAI-compatible endpoint (Qwen, DeepSeek, GLM, MiniMax)
13
OPENAI_API_KEY=
24
OPENAI_MODEL=gpt-4.1-mini
35
OPENAI_BASE_URL=
6+
7+
# OpenRouter (optional, alternative multi-model gateway)
48
OPENROUTER_API_KEY=
5-
TAVILY_API_KEY=
9+
10+
# Anthropic Claude (optional, auto-detected by model name prefix "claude")
611
ANTHROPIC_API_KEY=
12+
13+
# Google Gemini (optional, auto-detected by model name prefix "gemini")
714
GOOGLE_API_KEY=
15+
16+
# ── Optional Services ─────────────────────────────────────────────
17+
# Tavily web search (optional, used for URL source fetching)
18+
TAVILY_API_KEY=
19+
20+
# ── Output ────────────────────────────────────────────────────────
21+
# Directory for generated deck JSON and PPTX files (default: output)
822
AUTO_PPT_OUTPUT_DIR=output

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ docker run --rm -it -e OPENAI_API_KEY auto-ppt-engine python mcp_server.py # MC
157157
## Testing
158158

159159
```bash
160-
python -m pytest tests/ -v # 400+ tests
160+
python -m pytest tests/ -v # 408 tests
161161
npm run ci:smoke # JS renderer + end-to-end smoke
162162
```
163163

0 commit comments

Comments
 (0)