diff options
| author | Paul Buetow <paul@buetow.org> | 2025-07-18 20:18:48 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-07-18 20:18:48 +0300 |
| commit | f3c1b568ac28e211d218f0b33ccb85cf782ce248 (patch) | |
| tree | a56bec700741d4d8eb169480c795474d0d3c72ba | |
| parent | 12bbd55d5375254c7c8352cc321577adcfef67a6 (diff) | |
docs: update README with batch file translation format
- Added documentation for 'bulgarian = english' batch file format
- Included examples of all three supported formats
- Added note about API quota savings when providing translations
- Updated Quick Start section with example batch file
π€ Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
| -rw-r--r-- | README.md | 32 |
1 files changed, 31 insertions, 1 deletions
@@ -70,6 +70,14 @@ export OPENAI_API_KEY="sk-..." ```bash totalrecall --batch words.txt ``` + + Example `words.txt` with translations: + ``` + ΠΊΠ½ΠΈΠ³Π° = book + ΡΡΠΎΠ» = table + ΠΊΠΎΠΌΠΏΡΡΡΡ + ΠΌΠΎΠ»ΠΈΠ² = pencil + ``` 4. Generate with Anki package: ```bash @@ -137,7 +145,9 @@ totalrecall --gui ### Batch file format -Create a text file with one Bulgarian word per line: +Create a text file with Bulgarian words, optionally with English translations: + +**Format 1: Bulgarian words only** ``` ΡΠ±ΡΠ»ΠΊΠ° ΠΊΠΎΡΠΊΠ° @@ -146,6 +156,26 @@ Create a text file with one Bulgarian word per line: Π²ΠΎΠ΄Π° ``` +**Format 2: Bulgarian words with translations** +``` +ΠΊΠ½ΠΈΠ³Π° = book +ΡΡΠΎΠ» = table +ΠΏΡΠΎΠ·ΠΎΡΠ΅Ρ = window +ΠΊΠΎΠΌΠΏΡΡΡΡ = computer +ΠΌΠΎΠ»ΠΈΠ² = pencil +``` + +**Format 3: Mixed format** +``` +ΠΊΠ½ΠΈΠ³Π° = book +ΠΊΠΎΡΠΊΠ° +ΡΡΠΎΠ» = table +ΠΊΡΡΠ΅ +ΠΌΠΎΠ»ΠΈΠ² = pencil +``` + +When translations are provided, they are used directly without calling the translation API, saving time and API quota. Spaces around the words and translations are automatically trimmed. + ### Output Files For each word, the tool generates: |
