From 6f8e124faa9b3ac11f6b29fba39a554a222e9057 Mon Sep 17 00:00:00 2001 From: lbesnard Date: Thu, 17 Oct 2024 11:59:36 +1100 Subject: [PATCH] update readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 841fb8e..3995acc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -# Koreader_Highlights_2_Anki +# Koreader Highlights 2 Anki +Generates [Anki](https://ankiweb.net/) flashcards from highlighted text in [KOReader](https://koreader.rocks/) to create cloze deletions. +It utilizes the [BERT](https://huggingface.co/docs/transformers/en/model_doc/bert) model to assess word importance in sentences, allowing for the generation of effective +flashcards for study and revision. ## Installation with Poetry Clone the repo @@ -10,6 +13,10 @@ poetry install ### Usage +1. Mount your Ebook reader +2. Run the script +3. import the APKG into ANKI + ```bash poetry run koreader_highlights_2_anki -h usage: koreader_highlights_2_anki [-h] --input-folder INPUT_FOLDER --output-folder OUTPUT_FOLDER [--deck-name DECK_NAME] [--no-ai] [--select-files]