Skip to content

Commit d408bf0

Browse files
authored
Update README.md
1 parent 052e872 commit d408bf0

File tree

1 file changed

+1
-9
lines changed

1 file changed

+1
-9
lines changed

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,30 +60,22 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
6060
1. Clone this repository
6161

6262
2. Install dependencies:
63-
6463
```bash
6564
pip install -r requirements.txt
6665
```
6766

6867
3. Generate a complete codebase tutorial by running the main script:
69-
7068
```bash
7169
python main.py https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
7270
```
73-
7471
- `repo_url` - URL of the GitHub repository (required)
7572
- `-n, --name` - Project name (optional, derived from URL if omitted)
7673
- `-t, --token` - GitHub token (or set GITHUB_TOKEN environment variable)
7774
- `-o, --output` - Output directory (default: ./output)
7875
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
7976
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
8077
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
81-
82-
- Crawl GitHub repositories at specific commits or branches
83-
- Filter files by patterns (include/exclude)
84-
- Set maximum file size limits
85-
- Generate relative paths for simpler directory structures
86-
78+
8779
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).
8880

8981

0 commit comments

Comments
 (0)