diff options
| author | JJ | 2022-12-24 04:09:40 +0000 |
|---|---|---|
| committer | JJ | 2023-01-01 00:18:45 +0000 |
| commit | e2c4f8c46e27ba182471b945911b21ac6546bd4e (patch) | |
| tree | 611ed768f8200b7d1e4a93e50d14856dbe0d323f /README.md | |
Initial implementation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ea30d20 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +dictionarium +============ + +A speedy, offline, command-line dictionary based on Wiktionary. + +Inspired by the excellent [thesauromatic](https://github.com/cjrh/thesauromatic). + +Building +-------- +The environment variables `index_path` and `dictionary_path` must be set to the locations of a complete multistream bz2 index and archive from the [Wiktionary dumps](https://dumps.wikimedia.org/enwiktionary/), not included here as they're several gigabytes. +They are by default set to the last dumps from 2022 ([2022-12-20](https://dumps.wikimedia.org/enwiktionary/20221220/)), located in a top-level `data/` folder. |