---

File	Date	Author	Commit
build	2011-01-17	viktordick	[r1]
src	2011-01-24	viktordick	[r5]
Changelog	2011-01-17	viktordick	[r1]
LICENSE	2011-01-17	viktordick	[r1]
README	2011-01-17	viktordick	[r1]
SConstruct	2011-01-17	viktordick	[r1]
russia	2011-01-24	viktordick	[r5]
test	2011-01-17	viktordick	[r1]

Read Me

PREREQUISITES
You will need gtkmm-2.4 and scons (for building)
Unter Debian/Ubuntu, just
# apt-get install libgtkmm-2.4-dev scons

COMPILING
The file can be extracted with 7-zip or lzma, in the latter case by
$ tar --lzma -xf voctray-<version>.tar.lzma
(The '$' means that the command can be run as ordinary user, whereas a command
starting with '#' has to be run as root or with sudo. Do not actually put it in
front of the command.)
Now just type
$ cd voctray
$ scons

After that the executable is located in the directory 'build'. Under Linux you
also can
# scons install
to copy it into '/usr/local/bin'.

RUNNING
$ voctray [<file>]
Instead of passing the filename through a parameter, it can also be chosen in
the GUI. As of now, it is not possible to enter new vocables through the GUI,
so the file has to be prepared with your favorite text editor. The syntax is
pretty easy: for each vocable add a line consisting of
0<TAB>vocable<TAB>meaning
The 0 at the beginning is the number of the tray in which the vocable is put.
New vocables should always be put into the drawer 0. Each time the user knows a
vocable, it is put in the next tray whereas each time he doesn't, it is put
back into tray 0.
If the given answer is not correct, it is printed above the next
vocable and the user has the possibility to change the outcome by clicking on
the toggle button (for example if his answer was essentially correct but the
art of interpunctuation was not the same). In addition, the given answer is
printed at the top and if there is another word with this meaning, it is also
given.
If you don't understand anything of what I am talking about, just try for
yourself ^^
(Although I'm grateful for any suggestions to improve the program or the
documentation)