Skip to content

Commit cf6a4a7

Browse files
committed
Enhance Windows executable README with benchmark link and model recommendations
- Add prominent link to Wiki benchmarks for model selection - Include quick recommendations table (VRAM/model/language) - Add step to download model in Quick Start - Add useful links section (docs, benchmarks, issues, OpenRouter) - Improve formatting and organization
1 parent 6a6261c commit cf6a4a7

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

.github/workflows/build-windows.yml

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,31 @@ jobs:
6060
$readme = @"
6161
# TranslateBook Windows Executable
6262
63-
## Installation
63+
## Quick Start
6464
6565
1. Extract TranslateBook.exe to a folder of your choice
6666
2. Install Ollama from https://ollama.ai (required for local LLM)
67-
3. Double-click TranslateBook.exe to start the server
68-
4. Open your browser to http://localhost:5000
67+
3. Download a translation model: ollama pull qwen3:14b
68+
4. Double-click TranslateBook.exe to start the server
69+
5. Open your browser to http://localhost:5000
70+
71+
## Choosing the Best Model for Your Language
72+
73+
Different models perform better for different target languages!
74+
75+
📊 See our comprehensive benchmarks to find the best model for your target language:
76+
👉 https://github.com/hydropix/TranslateBookWithLLM/wiki
77+
78+
Benchmarks include 11 models tested across 19 languages with accuracy, fluency, and style scores.
79+
80+
### Quick Recommendations
81+
82+
| VRAM | Model | Best For |
83+
|------|-------|----------|
84+
| 8 GB | gemma3:12b | Spanish, Portuguese, European languages |
85+
| 24 GB | mistral-small:24b | French |
86+
| 24 GB | gemma3:27b | Japanese, Korean, Arabic, most languages |
87+
| 24 GB | qwen3:30b-instruct | Chinese (Simplified/Traditional) |
6988
7089
## First Run
7190
@@ -88,7 +107,12 @@ jobs:
88107
- Supported formats: .txt, .epub, .srt
89108
- Output files: TranslateBook_Data\translated_files\
90109
91-
For more information, visit: https://github.com/yourusername/TranslateBookWithLLM
110+
## Links
111+
112+
- 📚 Full Documentation: https://github.com/hydropix/TranslateBookWithLLM
113+
- 📊 Model Benchmarks: https://github.com/hydropix/TranslateBookWithLLM/wiki
114+
- 🐛 Report Issues: https://github.com/hydropix/TranslateBookWithLLM/issues
115+
- 🌐 OpenRouter Models: https://openrouter.ai/models (200+ cloud models)
92116
"@
93117
94118
$readme | Out-File -FilePath release\README.txt -Encoding UTF8

0 commit comments

Comments
 (0)