aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJJ2023-02-24 05:16:35 +0000
committerJJ2023-02-24 05:16:35 +0000
commitc1c5c3257b91f54d240b0fe3d6a844ce48ef6556 (patch)
tree3873522b29d1b624385e9cb7f18ad89b3537d0df
parent153e37eafb2b33c9863781b4b5d65210534949e1 (diff)
update readme
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index ea30d20..eecbb72 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,20 @@ A speedy, offline, command-line dictionary based on Wiktionary.
Inspired by the excellent [thesauromatic](https://github.com/cjrh/thesauromatic).
+Usage
+-----
+
+```bash
+[apropos@arch ~]$ dictionarium dictionarium
+Latin
+Etymology
+Renaissance Latin, from noun of action dictiō ("speaking") + ārium, from dīcō ("say, speak"). First attested in 1481.
+Noun
+dictiōnārium -1. dictionary
+Usage notes
+• Used especially in book titles, normally with adjective like Dictionarium Latino Lusitanicum ("Latin-Portuguese Dictionary"), Dictionarium Latinogermanicum/Latino-Germanicum ("Latin-German Dictionary")
+```
+
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.