--- /dev/null
+# Jiten-pai
+
+A Gjiten-lookalike Japanese dictionary written in Python.
+
+## Requirements
+
+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.
+
+## How to get and install dictionary files
+
+@@@ ToDo
+
+* EDICT2u [edict2u.gz](http://ftp.edrdg.org/pub/Nihongo/edict2u.gz)
+
+
+## Notes
+
+@@@ ToDo
+
+* ...
+
+## Known issues
+
+@@@ ToDo
+
+* KanjiDic is not implemented yet.
+* ...
+
+## License
+
+Jiten-pai incorporates parts taken from other projects, namely:
+
+* Kana conversion code adapted from [jaconv](https://github.com/ikegami-yukino/jaconv),
+ Copyright (c) 2014 Yukino Ikegami, MIT License
+
+* VCONJ verb de-inflection rule file taken from [Gjiten](http://gjiten.sourceforge.net/),
+ Copyright (c) 1999-2005 Botond Botyanszki, GNU General Public License v2.0
+
+The remaining majority of Jiten-pai code is distributed under the
+Modified ("3-clause") BSD License. See `LICENSE` file for more information.
"""
-_JITENPAI_VERSION = '0.0.7'
+_JITENPAI_VERSION = '0.0.8'
_JITENPAI_NAME = 'Jiten-pai'
_JITENPAI_DIR = 'jiten-pai'
_JITENPAI_CFG = 'jiten-pai.conf'