Skip to content

Commit c387aef

Browse files
authored
Add language parameter for multi-language support
1 parent ad9573a commit c387aef

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
> *Ever stared at a new codebase written by others feeling completely lost? This tutorial shows you how to build an AI agent that analyzes GitHub repositories and creates beginner-friendly tutorials explaining exactly how the code works.*
66
77
<p align="center">
8-
<img
8+
<img
99
src="./assets/banner.png" width="800"
1010
/>
1111
</p>
@@ -19,7 +19,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
1919
## ⭐ Example Results for Popular GitHub Repositories!
2020

2121
<p align="center">
22-
<img
22+
<img
2323
src="./assets/example.png" width="600"
2424
/>
2525
</p>
@@ -67,7 +67,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
6767

6868
1. Clone this repository
6969

70-
2. Install dependencies:
70+
2. Install dependencies:
7171
```bash
7272
pip install -r requirements.txt
7373
```
@@ -79,13 +79,13 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
7979
api_key=os.getenv("GEMINI_API_KEY", "your-api_key"),
8080
)
8181
```
82-
82+
8383
You can use your own models. We highly recommend the latest models with thinking capabilities (Claude 3.7 with thinking, O1). You can verify that it is correctly set up by running:
8484
```bash
8585
python utils/call_llm.py
8686
```
8787

88-
7. Generate a complete codebase tutorial by running the main script:
88+
4. Generate a complete codebase tutorial by running the main script:
8989
```bash
9090
# Analyze a GitHub repository
9191
python main.py --repo https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
@@ -100,17 +100,25 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
100100
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
101101
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
102102
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
103-
104-
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).
103+
- `--language` - Language for the generated tutorial (default: "english")
104+
105+
To generate tutorials in languages other than English, add the `--language` parameter:
106+
107+
```bash
108+
# Generate a tutorial in Spanish
109+
python main.py --repo https://github.com/username/repo --language "Spanish"
110+
```
111+
112+
The application will crawl the repository, analyze the codebase structure, generate tutorial content in the specified language, and save the output in the specified directory (default: ./output).
105113

106114

107115
## 💡 Development Tutorial
108116

109117
- I built using [**Agentic Coding**](https://zacharyhuang.substack.com/p/agentic-coding-the-most-fun-way-to), the fastest development paradigm, where humans simply [design](docs/design.md) and agents [code](flow.py).
110118

111119
- The secret weapon is [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework that lets Agents (e.g., Cursor AI) build for you
112-
113-
- Check out the Step-by-step YouTube development tutorial:
120+
121+
- Check out the Step-by-step YouTube development tutorial:
114122

115123
<br>
116124
<div align="center">

0 commit comments

Comments
 (0)