aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2019-04-19 04:43:57 +0300
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2019-04-19 04:43:57 +0300
commit7f54d1e60ea02fe5380a10adb88a1490d15d7b6c (patch)
treefd42988e9c99ba83edfab3d197136368dad363ad /README.md
parent96b3ecb3baa0acced9816f5749d14b05e18a3b09 (diff)
downloadopenrussian-cli-7f54d1e60ea02fe5380a10adb88a1490d15d7b6c.tar.gz
added a manpage and finalized README
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 25 insertions, 2 deletions
diff --git a/README.md b/README.md
index 91249b7..ef506df 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
# An Offline Console Russian Dictionary (based on openrussian.org)
+This is an offline console and terminal-friendly Russian dictionary,
+based on the database of [https://en.openrussian.org/](openrussian.org).
+
* Works offline (without internet access) and is very fast.
This really pays off if you browse Russian words a lot.
* It integrates well into the console environment - browse dictionary
@@ -65,16 +68,36 @@ You are of course welcome to contribute patches. :-)
## Examples
+A simple lookup:
+
openrussian саморазрушение
+
+Display the German translation:
+
openrussian -Lde саморазрушение
- openrussian самора[сз]рушение
+
+If you are unsure which consonants appear in this word:
+
+ openrussian самора[сз]ру[шщ]ение
+
+Find more words derived from "разрушение":
+
openrussian *разрушение
+
+Avoid ambiguous search results:
+
openrussian -V коса
+
+Look up by translation:
+
openrussian catch a cold
Graphical display using `groffer`:
- openrussian -p кошка | groffer -Kutf8 --mode pdf2 -fSTIX
+ openrussian -p кошка | groffer -Kutf8 --mode pdf2
+
+You may have to specify a non-default font supporting
+cyrillic characters via groffer's `-f` option.
## License