Update README.md

This commit is contained in:
Zachary Huang
2025-05-04 17:08:47 -04:00
committed by GitHub
parent c238dba586
commit 390c8c9b06
+6 -3
View File
@@ -73,13 +73,16 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
## 🚀 Getting Started ## 🚀 Getting Started
1. Clone this repository 1. Clone this repository
```bash
git clone https://github.com/The-Pocket/PocketFlow-Tutorial-Codebase-Knowledge
```
2. Install dependencies: 3. Install dependencies:
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
3. Set up LLM in [`utils/call_llm.py`](./utils/call_llm.py) by providing credentials. By default, you can use the AI Studio key with this client for Gemini Pro 2.5: 4. Set up LLM in [`utils/call_llm.py`](./utils/call_llm.py) by providing credentials. By default, you can use the AI Studio key with this client for Gemini Pro 2.5:
```python ```python
client = genai.Client( client = genai.Client(
@@ -92,7 +95,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
python utils/call_llm.py python utils/call_llm.py
``` ```
4. Generate a complete codebase tutorial by running the main script: 5. Generate a complete codebase tutorial by running the main script:
```bash ```bash
# Analyze a GitHub repository # Analyze a GitHub repository
python main.py --repo https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000 python main.py --repo https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000