From e2c4f8c46e27ba182471b945911b21ac6546bd4e Mon Sep 17 00:00:00 2001
From: JJ
Date: Fri, 23 Dec 2022 20:09:40 -0800
Subject: Initial implementation

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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.
-- 
cgit v1.2.3-70-g09d2