Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lbesnard committed Oct 17, 2024
1 parent e6f8466 commit 6f8e124
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
Expand Down

0 comments on commit 6f8e124

Please sign in to comment.