README.md

AnkiBot

Telegram bot for learning foreign words via the anki program

• Based on aiogram python module
• Used json lib for storing user dictionaries

How it works

Anki program utilizes spaced repetition. Spaced repetition has been shown to increase rate of memorization.
There are 4 states of memorizing a word. After deck creating all words in it have 1st (lowest) state.

1. First of all create your first deck
   • Click on the «Create deck» button
   • Send a list of words. Use this format:

     ---

     Deck title
     word1 front side - word1 back side
     word2 front side - word2 back side

     ---

2. Start learning words
   • Click on the «Start learning» button
   • Bot sends the list of your word deck, you can test knowledge or remind words of each deck
   • In test mode bot sends random word of chosen deck
     • Random choice of a word depends on its state: words with a low state are more likely to be selected than with a high state
     • If it's the word's front side, you can listen this word. Voice generated via Voicerss API
     • If your answer is correct that word moves into the next state
       • If state of word was last then word deletes from deck
     • If your answer is wrong state doesn't change
   • In showing words mode bot sends complete list of words of chosen deck via Telegraph API
3. You can also edit or delete any deck. Just choose corresponding button