README file for Tagaini Jisho
This is Tagaini Jisho, a free software Japanese dictionary and learning assistant.
Tagaini Jisho is designed to help you remember Japanese vocabulary and kanji (later referred as 'entries') by presenting them in a way that makes it easy to create connections between them. It does so by keeping track of all the entries you already know and want to study, and letting you tag and annote them, in addition to providing easy navigation between related entries. A powerful search engine also allows you to search for entries very precisely. Finally, Tagaini let you produce printed material (including a handy foldable pocket book) so let you study anywhere.
Tagaini Jisho runs on Linux/Unix, MacOS X, and Microsoft Windows.
Copyright (C) 2008-2013 Alexandre Courbot.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the COPYING file for more details.
Documentation is Copyright (C) 2010 Neil Caldwell & Alexandre Courbot, distributed under the Creative Commons Attribution-Share Alike 3.0 license.
- Japanese dictionary based on JMdict.
- Kanji dictionary based on kanjidic2 and KanjiVG.
- Powerful search engine with many search parameters: JLPT level, part-of-speech, etc.
- Entries can be marked for study and have a score that evolves as you correctly recognize them.
- Training mode for studied entries, where lowest score entries are more likely to be trained.
- Lists based on your training history. Get a convenient list of all the entries you mistaken today, yesterday or this week!
- Tagging of entries.
- Annotation of entries.
- Print feature with connections between studied kanji and vocabulary, in a format that allows both studying and flash-carding (thumb-hideable Japanese part).
The only runtime dependency to run Tagaini Jisho is Qt 5.4 or higher. In order to compile it, you will also need CMake 2.8.1 or higher.
Compilation requires two steps: first, the program is compiled, and second, the dictionaries it uses are created.
To compile the program, you first need to invoke cmake in order to generate Makefiles for your platform:
$ cmake .
Unix users: by default, the program will be installed into /usr/local. You can
change this by setting the
CMAKE_INSTALL_PREFIX variable when invoking CMake:
$ cmake . -DCMAKE_INSTALL_PREFIX=/path/to/install/dir
You may want to produce a debug build, especially if you are trying a
development version and want to be able to reports problems. Adding the
-DCMAKE_BUILD_TYPE=Debug option to CMake's command line will produce a binary
with debug symbols built-in.
You can also use
ccmake . after having run CMake to change these options. It
also features a couple of further debugging options that you can enable in case
you run into troubles.
After your build directory is configured, compilation may be performed. On Unix systems, invoking make will be enough:
This will take some time, especially to generate the dictionaries databases.
Finally, you can install the program to its destination:
# make install
But you may prefer to generate installers or packages for your platform using CPack. Mac users can obtain an installable DMG image by running the following command:
$ cpack -G DragNDrop
Linux users can make a nice deb or rpm package:
$ cpack -G DEB $ cpack -G RPM
Compiling on macOS
Add your Qt bin dir to PATH so CMake can automatically find it.
For Qt from Homebrew:
$ export PATH=$PATH:/usr/local/opt/qt/bin
For Qt from official package (for ex Qt 5.6):
$ export PATH=$PATH:$HOME/Qt/5.6/clang_64/bin
Make build directory:
$ cd $PROJECT $ mkdir build && cd build
$ cmake -DCMAKE_INSTALL_PREFIX=$HOME/Applications -DEMBED_SQLITE=1 ..
Install (application bundle will be installed to $HOME/Applications):
$ make install
Compiling with Microsoft Visual Studio
The CMake build harness has been tested with Visual Studio 10 under Windows7. First, from your VStudio command environment, invoke CMake to create the VStudio Solution:
c:\dev\mrosen-tagainijisho> msbuild tagainijisho.sln> cmake -G "Visual Studio 10" -DCMAKE_PREFIX_PATH=c:/Qt/5.4/msvc2010_opengl -DGUNZIP=c:/bin/gzip-1.3.12-1-bin/bin/gunzip.exe
Then, to build the project, including building the databases:
CMAKE_PREFIX_PATH definition, CMAKE was unable to find my Qt
library. It was looking so maybe it will find yours without this.
Similarly, I needed to tell it where GUNZIP was (required only once, see comments in CMakeLists.txt), hence that definition on the CMake command line. You may not need this.
For a detailed user manual, please see http://www.tagaini.net/manual.
In addition to Qt's standard arguments, Tagaini also supports the following command-line arguments:
--temp-db start the program on an empty, temporary database that will be
removed once the program exits. This is useful for testing new things on a
- Kanji stroke order may not always be accurate. Please report incorrect kanji to http://groups.google.com/group/tagaini-jisho.
- Kanji stroke color segmentation is not always accurate.
- JLPT levels may not always be accurate.
Tagaini Jisho makes heavy use of the embedded SQLite database. Many thanks to all its developers for making such a great embedded database available, and for their kind support.
Qt4 is used as a development framework and ensures portability between Linux, Mac OS, and Windows.
Words definitions are provided by the JMDict.
Kanji information come from the kanjidic2 project.
Kanji components, and stroke animations come from the KanjiVG project.
Application icon has been contributed by Philip Seyfi.
Flag images by Mark James.
Development, bug reports, feature requests and general questions are handled on GitHub: https://github.com/Gnurou/tagainijisho