From 9e3ede71cb0abc45bb6c31bede1bd837df794e71 Mon Sep 17 00:00:00 2001
From: Urban Wallasch <urban.wallasch@freenet.de>
Date: Fri, 18 Jun 2021 15:08:49 +0200
Subject: [PATCH] * Amended README.

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 49 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 8a85cc2..c8b7828 100644
--- a/README.md
+++ b/README.md
@@ -2,31 +2,72 @@
 
 A Gjiten-lookalike Japanese dictionary written in Python.
 
-## Requirements
+## Prerequisites
 
-Running `jiten-pai.py` requires Python version >= 3.7 installed,
-plus the PyQt5 python bindings for Qt5.
+Running `jiten-pai.py` requires Python version >= 3.7 installed, plus the
+PyQt5 python bindings for Qt5. Tested with Python 3.7.3, PyQt5 5.11.3.
 
-Tested with Python 3.7.3, PyQt5 5.11.3.
+Dictionary files are not included in Jiten-pai, these have to be downloaded
+and installed separately, see next section.
 
-## How to get and install dictionary files
 
-@@@ ToDo
+## Get and Install Dictionary Files
+
+Jiten-pai supports dictionary files in EDICT format, as made available by the
+[Electronic Dictionary Research and Development Group](http://www.edrdg.org/)
+as part of the *Japanese/English Dictionary Project*:
+
+* [EDICT2u](http://ftp.edrdg.org/pub/Nihongo/edict2u.gz) *(recommended)*
+    * EDICT main dictionary, modern format, UTF-8 coding
+    * download file to a convenient location, unpack like this:
+      > `gunzip edict2u.gz`
+    * install in Jiten-pai using the Edit->Preferences dialog
+
+* [EDICT](http://ftp.edrdg.org/pub/Nihongo/edict.gz) *(not recommended)*
+    * same as above, legacy format, EUC-JP coding
+    * download file, then unpack and convert to UTF-8:
+      > `zcat edict.gz | recode EUC-JP..UTF-8 > edict`
+    * install using Edit->Preferences
+
+The following is part of the *Japanese Proper Names Dictionary project*:
+
+* [ENAMDICT](http://ftp.edrdg.org/pub/Nihongo/enamdict.gz) *(optional)*
+    * named entity dictionary, EUC-JP coding
+    * download file, then unpack and convert to UTF-8:
+      > `zcat enamdict.gz | recode EUC-JP..UTF-8 > enamdict`
+    * install using Edit->Preferences
 
-* EDICT2u [edict2u.gz](http://ftp.edrdg.org/pub/Nihongo/edict2u.gz)
+Additional dictionaries and alternative language versions are available at
+the EDRDG, see the [FTP archive](http://ftp.edrdg.org/pub/Nihongo/#dic_fil).
+The respective accompanying documentation will have the details, and in
+particular indicate whether a file is actually in EDICT format. In many
+cases a conversion from EUC-JP to UTF-8 will be necessary, as outlined in
+the examples above.
 
 
 ## Notes
 
 @@@ ToDo
 
-* ...
+* If the search term contains any Katakana or Hiragana, Jiten-pai will
+  always report matches for both syllabaries. This is intentional.
+
+* During startup Jiten-pai will look for the `vconj.utf8` verb conjugation
+  file in the following directories, in the given order:
+    * `$HOME/.local/share/jiten-pai/`
+    * `/usr/local/share/jiten-pai/`
+    * `/usr/share/jiten-pai/`
+    * `current working directory`
+
+    Without this file the verb de-inflection option will not be available.
+
 
 ## Known issues
 
 @@@ ToDo
 
 * KanjiDic is not implemented yet.
+
 * ...
 
 ## License
-- 
2.30.2