You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
> *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.*
6
6
7
7
<palign="center">
8
-
<img
8
+
<img
9
9
src="./assets/banner.png" width="800"
10
10
/>
11
11
</p>
@@ -19,7 +19,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
19
19
## ⭐ Example Results for Popular GitHub Repositories!
20
20
21
21
<palign="center">
22
-
<img
22
+
<img
23
23
src="./assets/example.png" width="600"
24
24
/>
25
25
</p>
@@ -67,7 +67,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
67
67
68
68
1. Clone this repository
69
69
70
-
2. Install dependencies:
70
+
2. Install dependencies:
71
71
```bash
72
72
pip install -r requirements.txt
73
73
```
@@ -79,13 +79,13 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
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:
84
84
```bash
85
85
python utils/call_llm.py
86
86
```
87
87
88
-
7. Generate a complete codebase tutorial by running the main script:
88
+
4. Generate a complete codebase tutorial by running the main script:
@@ -100,17 +100,25 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
100
100
- `-i, --include` - Files to include (e.g., "*.py""*.js")
101
101
- `-e, --exclude` - Files to exclude (e.g., "tests/*""docs/*")
102
102
- `-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:
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).
105
113
106
114
107
115
## 💡 Development Tutorial
108
116
109
117
- 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).
110
118
111
119
- 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:
0 commit comments