Skip to content

Commit

Permalink
adjust github page
Browse files Browse the repository at this point in the history
  • Loading branch information
GeoFro committed Dec 7, 2024
1 parent 4213f90 commit 5d54136
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ <h2>Installation</h2>

<h2>Usage</h2>

<h3>Interactive Mode</h3>
<ol>
<li>
<p>Run the application:</p>
Expand All @@ -104,6 +105,37 @@ <h2>Usage</h2>
</li>
</ol>

<h3>Batch Mode</h3>
<p>In addition to the interactive mode, you can process multiple phrases at once using batch mode:</p>

<ol>
<li>
<p>Create a <code>phrases.txt</code> file in the project directory (you can copy from <code>phrases.txt.example</code>):</p>
<pre><code>cp phrases.txt.example phrases.txt</code></pre>
<p>Then edit <code>phrases.txt</code> with your phrases, one per line:</p>
<pre><code># Lines starting with # are ignored as comments
hello
goodbye
thank you
how are you</code></pre>
</li>
<li>
<p>Run the batch processor:</p>
<pre><code>npm run batch</code></pre>
</li>
<li>
<p>For each phrase, the application will:</p>
<ul>
<li>Show the translation</li>
<li>Ask for confirmation</li>
<li>Generate audio files</li>
<li>Add the card to your deck if confirmed</li>
</ul>
</li>
</ol>

<p>This is particularly useful when you have a list of phrases prepared in advance.</p>

<p>For more information and the source code, visit the <a href="https://github.com/GeoFro/anki-assistant">GitHub repository</a>.</p>
</body>
</html>

0 comments on commit 5d54136

Please sign in to comment.