From: Urban Wallasch <urban.wallasch@freenet.de>
Date: Fri, 18 Jun 2021 09:53:44 +0000 (+0200)
Subject: * Addded bare-bones README.md.
X-Git-Tag: v0.1.0~111
X-Git-Url: https://git.packet-gain.de/?a=commitdiff_plain;h=04c91142d8a6f4d3a0a5cbffc9353cdd3685c752;p=jiten-pai.git

* Addded bare-bones README.md.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a85cc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# 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.
diff --git a/jiten-pai.py b/jiten-pai.py
index 652f2b1..86ccd8a 100755
--- a/jiten-pai.py
+++ b/jiten-pai.py
@@ -13,7 +13,7 @@ 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'