Skip to content

Commit d9e632f

Browse files
committed
update readme
1 parent 4cb6ed2 commit d9e632f

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,43 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
5151
- [SmolaAgents](https://the-pocket.github.io/Tutorial-Codebase-Knowledge/SmolaAgents) - Build tiny AI agents that punch way above their weight class!
5252

5353

54+
## 🚀 Getting Started
55+
56+
1. Clone this repository
57+
58+
2. Install dependencies:
59+
60+
```bash
61+
pip install -r requirements.txt
62+
```
63+
64+
3. Generate a complete codebase tutorial by running the main script:
65+
66+
```bash
67+
python main.py https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
68+
```
69+
70+
- `repo_url` - URL of the GitHub repository (required)
71+
- `-n, --name` - Project name (optional, derived from URL if omitted)
72+
- `-t, --token` - GitHub token (or set GITHUB_TOKEN environment variable)
73+
- `-o, --output` - Output directory (default: ./output)
74+
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
75+
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
76+
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
77+
78+
- Crawl GitHub repositories at specific commits or branches
79+
- Filter files by patterns (include/exclude)
80+
- Set maximum file size limits
81+
- Generate relative paths for simpler directory structures
82+
83+
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).
84+
85+
86+
## 💡 Development Tutorial
87+
88+
- 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).
89+
90+
- 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
91+
92+
- Step-by-step YouTube development tutorial coming soon! Please subscribe to my [YouTube Channel](https://www.youtube.com/@ZacharyLLM?sub_confirmation=1)
5493

0 commit comments

Comments
 (0)