Skip to content

Commit 6f8e124

Browse files
committed
update readme
1 parent e6f8466 commit 6f8e124

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
# Koreader_Highlights_2_Anki
1+
# Koreader Highlights 2 Anki
22

3+
Generates [Anki](https://ankiweb.net/) flashcards from highlighted text in [KOReader](https://koreader.rocks/) to create cloze deletions.
4+
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
5+
flashcards for study and revision.
36

47
## Installation with Poetry
58
Clone the repo
@@ -10,6 +13,10 @@ poetry install
1013

1114
### Usage
1215

16+
1. Mount your Ebook reader
17+
2. Run the script
18+
3. import the APKG into ANKI
19+
1320
```bash
1421
poetry run koreader_highlights_2_anki -h
1522
usage: koreader_highlights_2_anki [-h] --input-folder INPUT_FOLDER --output-folder OUTPUT_FOLDER [--deck-name DECK_NAME] [--no-ai] [--select-files]

0 commit comments

Comments
 (0)