mirror of
https://github.com/aljazceru/Tutorial-Codebase-Knowledge.git
synced 2026-02-02 13:14:27 +01:00
Add language parameter for multi-language support
This commit is contained in:
12
README.md
12
README.md
@@ -85,7 +85,7 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
|
|||||||
python utils/call_llm.py
|
python utils/call_llm.py
|
||||||
```
|
```
|
||||||
|
|
||||||
7. Generate a complete codebase tutorial by running the main script:
|
4. Generate a complete codebase tutorial by running the main script:
|
||||||
```bash
|
```bash
|
||||||
# Analyze a GitHub repository
|
# Analyze a GitHub repository
|
||||||
python main.py --repo https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
|
python main.py --repo https://github.com/username/repo --include "*.py" "*.js" --exclude "tests/*" --max-size 50000
|
||||||
@@ -100,8 +100,16 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
|
|||||||
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
|
- `-i, --include` - Files to include (e.g., "*.py" "*.js")
|
||||||
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
|
- `-e, --exclude` - Files to exclude (e.g., "tests/*" "docs/*")
|
||||||
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
|
- `-s, --max-size` - Maximum file size in bytes (default: 100KB)
|
||||||
|
- `--language` - Language for the generated tutorial (default: "english")
|
||||||
|
|
||||||
The application will crawl the repository, analyze the codebase structure, generate tutorial content, and save the output in the specified directory (default: ./output).
|
To generate tutorials in languages other than English, add the `--language` parameter:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Generate a tutorial in Spanish
|
||||||
|
python main.py --repo https://github.com/username/repo --language "Spanish"
|
||||||
|
```
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
|
||||||
## 💡 Development Tutorial
|
## 💡 Development Tutorial
|
||||||
|
|||||||
Reference in New Issue
Block a user