aljaz/Tutorial-Codebase-Knowledge
1
0
Fork 0
mirror of https://github.com/aljazceru/Tutorial-Codebase-Knowledge.git synced 2025-12-18 15:04:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Zach
2025-04-04 17:42:17 -04:00
committed by GitHub
parent 052e8720eb
commit d408bf09c8
1 changed files with 1 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -60,17 +60,14 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
1. Clone this repository
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Generate a complete codebase tutorial by running the main script:
```bash
python main.py https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
```
- `repo_url` - URL of the GitHub repository (required)
- `-n, --name` - Project name (optional, derived from URL if omitted)
- `-t, --token` - GitHub token (or set GITHUB_TOKEN environment variable)
@@ -78,12 +75,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
- Crawl GitHub repositories at specific commits or branches
- Filter files by patterns (include/exclude)
- Set maximum file size limits
- Generate relative paths for simpler directory structures
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).