Skip to content

Commit

Permalink
docs: add recording
Browse files Browse the repository at this point in the history
  • Loading branch information
kamoo1 committed Mar 25, 2024
1 parent 9ed96a7 commit 6b06ce7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.gif filter=lfs diff=lfs merge=lfs -text
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Anki Word Frequency

Add word frequency to your Anki cards, powered by [wordfreq](https://github.com/rspeer/wordfreq).

Frequency value is logarithmically scaled for readability,
defined [here](https://github.com/rspeer/wordfreq/blob/ce5307748723ddfb47eec26c3ece2eb8216c897a/README.md#usage).

Supported languages listed [here](https://github.com/rspeer/wordfreq/blob/ce5307748723ddfb47eec26c3ece2eb8216c897a/README.md#sources-and-supported-languages).

![recording](assets/recording.gif)

## Usage
1. Add a new field named "Frequency" (defined in config) to your card type.
1. Select target cards in the browser, they should have a field named "Front" (also configurable).
1. Right click and choose your language under "Word Frequency" tab to update the frequency field.


## Known Issues
- Tested on Windows, should support most variants of Linux and MacOS.
- Some custom tokenizers in the dependencies write logs to *stderr* (e.g. `jieba`), this will get displayed in a error popup window in Anki, but can be safely ignored.
3 changes: 3 additions & 0 deletions assets/recording.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b06ce7

Please sign in to comment.