From 7f54d1e60ea02fe5380a10adb88a1490d15d7b6c Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Fri, 19 Apr 2019 04:43:57 +0300 Subject: added a manpage and finalized README --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3