diff options
| -rw-r--r-- | README.md | 30 |
1 files changed, 23 insertions, 7 deletions
@@ -1,20 +1,36 @@ # README -This program provides a fast local dictionary, with the option to add any word & its definition to Anki. +This program provides a fast local dictionary, with the option to add any word & +its definition to Anki. -You'll need a working Go runtime in order to build this program. Usually you can get this from your distribution's package manager, or from https://go.dev/doc/install. +You'll need a working Go runtime in order to build this program. Usually you can +get this from your distribution's package manager, or from +https://go.dev/doc/install. ## Getting started -You need a copy of https://kaikki.org/frwiktionary/raw-wiktextract-data.jsonl.gz. Uncompress it to raw-wiktextract-data.jsonl. This is a structured dump of French wiktionary. +You need a copy of +https://kaikki.org/frwiktionary/raw-wiktextract-data.jsonl.gz. Uncompress it to +raw-wiktextract-data.jsonl. This is a structured dump of French wiktionary. -To be able to add Anki cards, you need to install the `anki-connect` extension. You can find instructions to do so here: https://git.sr.ht/~foosoft/anki-connect When you're running this app, you'll also need to have Anki open (with the `anki-connect` plugin installed) in order to add new cards. +To be able to add Anki cards, you need to install the `anki-connect` extension. +You can find instructions to do so here: https://git.sr.ht/~foosoft/anki-connect +When you're running this app, you'll also need to have Anki open (with the +`anki-connect` plugin installed) in order to add new cards. -Also from Anki, take note of the name of the Deck where you want to add new cards, and the `Type` of these cards (appears in the upper-left of the 'add new cards' dialog in Anki). +Also from Anki, take note of the name of the Deck where you want to add new +cards, and the `Type` of these cards (appears in the upper-left of the 'add new +cards' dialog in Anki). -(Note: currently this application assumes that your card type has two fields: "Front" and "Back". Eventually, this may be configurable. If the fields are called something else in your card type, you'll currently have to update the json tags for the `fields` struct in `add.go`.) +(Note: currently this application assumes that your card type has two fields: +"Front" and "Back". Eventually, this may be configurable. If the fields are +called something else in your card type, you'll currently have to update the +json tags for the `fields` struct in `add.go`.) -With all this done, you can now run the app! The first time you run it, the app will build a SQLite database of words and definitions from the Wiktionary data, which will take a minute or two. From the root of this repository, you can use a command like this to start the app: +With all this done, you can now run the app! The first time you run it, the app +will build a SQLite database of words and definitions from the Wiktionary data, +which will take a minute or two. From the root of this repository, you can use a +command like this to start the app: ``` go run . -rawDictionary=raw-wiktextract-data.jsonl -deck="Français" -model="Basic-830ae" |