This program is GPL 2 licensed free software and
  
   IT COMES WITH ABSOLUTELY NO WARRANTY

Version:   3.1.0
Location:  https://yudit.org/
Author:    Gaspar Sinai <gaspar@yudit.org>
Copyright: Released under the GNU General Public License, version 2, 
           dated June 1991, worded by the Free Software Foundation.
           Please read the file COPYING. (GNU)
           
Features
========
 o The kinput2 method is directly supported for Japanese.
 o X Input Method support. 
 o Handwriting recognition support.
 o Easy-to-make key-input maps that can be
   created to input scripts with a two-way English transliteration
   scheme. Yudit comes with more than 100 keyboard maps
   contributed by Yudit users from all over the World.
 o Built-in printing support
   High quality and locale independent postscript is generated.
 o Direct True Type / Open Type font support.
   Yudit does not need X11 TTF support to show your text. 
 o Yudit can display and print your text with a
   mixture of X11 fonts/True Type fonts.
   Unicode glyphs are widely available these days but still there are
   some scripts that need this feature. 
 o Cut and paste, load and save your text with various encodings. 
   It is possible to create a unicode text file in Linux and read 
   it in MS Notepad on NT. (utf-16)
 o Keyboard input maps can be used as text converters. This means that
  you can make instant transliterations of your scripts.
  If the transliterations is reversible, it is possible to read it
  back get the original text back. 
 o Unlinimted  undo/redo.
 o Overstriking and OTF  composing-character support. 
 o 31-bit Unicode support.
 o Drag-and-Drop  (xdnd and Dnd) support. 
 o Full Bidirectional text support.
 o Hagul Jamos with mslvt encoder (hardwired for ogulim.ttf) and X11 fonts 
 o Arabic, Syriac,... shaping support. 
 o Indic scripts: Tamil,Devanagari,Bengali,Gujarati,Gurmukhi,
   Oriya,Malayalam,Kannada and Telugu
 o Hungarian Runes (rovásírás) support in Private Use Area
 o Software glyph mirroring (Hungarian Runes,Old Italic)
 o External spell-checker (Hunspell) support
 o Interface for external text encryption (stoolki/sedy)
 o Configurable GUI scaling (yudit.scale property)

How to Install
==============
Prerequisites:
--needed: gcc-2.96 or better  http://gcc.gnu.org/
--needed: gmake 3.75 or greater ftp://prep.ai.mit.edu/
--needed: X11R5 or greater (www.xfree86.org)
--For the above on ubuntu: sudo apt install net-tools libx11-dev
--recommended gettext 0.10 or better for multi-language message support
  From version-2.4.8 it is only needed when making your own messages.
  Reading gettext generated files are internally supported.
--optional: a lot of True Type fonts are available for free:
  From www.microsoft.com you can get gulim (Hangul), msgothic (Japanese) for IE.
  The default font configuration uses NotoSans fonts, you can find the
  default font configuration in README.TXT
  Please note the fonts are read from yudit.fontpath in yudit.properties and
  ~/.yudit/fonts

--recommended:
  Several UCS fonts:
    http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
  Unifont:
    http://www.czyborra.com/unifont/
--recommened literature:
  http://www.cl.cam.ac.uk/~mgk25/unicode.html

Installation Process
====================
Linux:

1. Get the latest source rpm 

   wget http://www.yudit.org/download/yudit-3.1.0-1.src.rpm

2. Use rpmbuild to build a binary rpm package 

   rpmbuild -ba yudit-3.1.0-1.src.rpm

3. For Ubuntu you can use the alien program to make a deb
package from the binary rpm made by rpmbuild.

Solaris:

1. configure --prefix=/opt/Misc
2. make
3. make install

FreeBSD:

1. ./configure --prefix=/usr/local
2. gmake
3. gmake install

Windows:
1. Install  Microsoft Windows SDK for Windows 7 and .NET

   On Window98 You need at least Visual C++ 6.0, and the command prompt
   should be invoked with 

   command /e:2040 /p
   
2. Install UnxTools

   http://sourceforge.net/projects/unxutils/

   If you put the package in 

   C:\Build\Unix

   set PATH=C:\Build\Unix\bin;C:\Build\Unix\usr\local\wbin;%PATH%

3. Unpack yudit-3.1.0.tar.gz into C:\Build\Yudit\yudit-3.1.0

   gunzip yudit-3.1.0.tar.gz
   tar xf yudit-3.1.0.tar

   This directory is hardcoded into:
     bin/wininst.bat, Makefile.conf(TOPDIR) and yudit.iss)
   If you unpacked the source code into a different folder,
   you need to modify these.

4. Compile

  Execute the vcvars32.bat  (32 bit) or vcvarsx86_amd64.bat (64 bit) 
  script in your compiler installation bin directory.

  You should probably search for the vcvars32.bat or vcvars64.bat
  files of your installed vc++ tree, and use those if you have problems.

  cd yudit-3.1.0
  cp Makefile.in Makefile
  make

5. Prepeare (This will create C:\Build\Yudit\Install directory)

  yudit-3.1.0\bin\wininst

6. Create package (This needs C:\Build\Yudit\Output directory)

  Install Inno Setup Compiler (http://www.jrsoftware.org/isdl.htm)
  Use C:\Build\Yudit\yudit-3.1.0\yudit32.iss (32 bit) or 
  C:\Build\Yudit\yudit-3.1.0\yudit64.iss (64 bit)

  Compile the package. It creates an Output directory with the installer
  executable.

Macintosh
========
1. You need to download the source code for Yudit.

  Check out latest version (3.1.0) and download it with curl.

  curl -O https://yudit.org/download/betas/yudit-3.1.0.tar.gz

2. You need to make sure Your Mac has developer tools installed.

3. Open the terminal window

4. Unpack the source code

  tar xfz yudit-3.1.0.tar.gz

5. Go to the source folder

  cd yudit-3.1.0

6. Configure and compile
You can build Yudit the same way as you do on Linux,
but there is a better way to create a dmg image.

For that you just need to run 
  ./build-for-macos.sh

Please read further instructions in README-MACOS.TXT

How to make an rpm package form Yudit sources
=============================================
1. rpm -tb yudit-3.1.0.tar.gz
  or if it does not work:
   rpmbuild -tb yudit-3.1.0.tar.gz

  This will tell you where to put the compressed source code.Put it there.
  Most likely:
  Suse: /usr/src/packages/SOURCES/yudit-3.1.0.tar.gz
  or
  Redhat: /usr/src/redhat/SOURCES/yudit-3.1.0.tar.gz
2. rpm -i [binary rpm]

Does the GUI speak my language?
==============================
Yudit menus can be displayed in several languages.

In  ~/.yudit/yudit.properties file you can specify:

    yudit.default.language=language_code

The following languages are supported:

Tag Country/Language      Translated and contributed by 
=== ===================   =============================
am  Amharic/Ethiopia      Daniel Yacob <locales@geez.org>
ar  Arabic/               Mohamed kebdani <kebdani1@iam.net.ma>
az  Azerbaijani Turkish   Vasif İsmailoglu <azerb_linux@hotmail.com>
bn  Bengali               Anirban Mitra <mitra_anirban@yahoo.co.in>
bg  Bulgaria/Bulgarian    Alexander Shopov <ash@contact.bg>
de  Germany/German        Thomas Wohlfarth <Thomas.Wohlfarth@gmx.net>
cs  Czechia/Czech         Lubos Stanek <stanekl@atlas.cz>
en  US/English            Gáspár Sinai <gaspar@yudit.org>
el  Greece/Greek          Velonis Petros <velonis@freemail.gr>
es  Spain/Spanish         Juan Rafael Fernández García <jrfern@bigfoot.com>
fi  Finland/Finnish       Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com>
fr  France/French         Olivier Faucheux <olivier.faucheux@etu.enseeiht.fr>
ga  Irish                 Kevin Patrick Scannell <scannell@slu.edu>
gu  Gujarati              Vibha Sinojia <vibhavachhani@hotmail.com>
hi  Hindi                 Sanjay Khatri <sk_ind@vsnl.net>
hu  Hungary/Hungarian     Gáspár Sinai <gaspar@yudit.org>
ja  Japan/Japanese        Inui Yuko / Gáspár Sinai <yuko@yudit.org>
ko  Korea/Korean          Jungshik Shin <jshin@mailaps.org> 
mn  Mongolia/Mongolian    Natsagdorj Shagdar <natsagdorj@t-online.de>
mr  Marathi               Swapnil Hajare<dreamil1000a@yahoo.com>
pa  Punjabi               Madhusudan Singh <chhabra@eecs.umich.edu>
pl  Polish/Poland         Pawel Zawila-Niedzwiecki <zawel@wgt.com.pl>
ru  Russian/Russia        Вячеслав Диконов Vyacheslav Dikonov <sdiconov@mail.ru>
sl  Slovenia/Slovenian    Roman Maurer <roman.maurer@amis.net>
sr  Yugoslavia/Serbian    Slobodan Marković <twiddle@eunet.yu> 
ta  Tamil                 Thuraiappah Vaseeharan <t_vasee@yahoo.com>
uk  Ukrainian             Solotskyy Mykola <salo@tokyo.email.ne.jp>
ur  Urdu/Pakistan         S H A N <shanali@singnet.com.sg>
vi  Vietnamese/Vietnam    Hoan <hoan@wanadoo.fr>
yi  Israel/Yiddish        Raphael Finkel <raphael@cs.uky.edu>
zh  Chinese/HongKong      Joe Man <trmetal@yahoo.com.hk>
zh_CN Chinese/Simplified  Zhou Jinnian <zhoujinnian168@yahoo.com>

If you specify 

    yudit.default.language=default

The environment variable LANG will be used to determine the 
language. Use this option sparingly - it is not guaranteed that
the font is available.
--------------------
Font Configuration
--------------------

If your language does not appear properly, you might need to
change 
 yudit.default.font=default
to
 yudit.default.font=MyVirtualFont

The components of the default font, or any yudit font
can be checked by typing "uniprint -h" on the command line.

The configuration file ~/.yudit.properties contain a
comma separated
   yudit.fontpath=
This is where yudit looks for fonts when not found in
  ~/.yudit/fonts.
The fonts from Yudit installation directory is 
searched last.

How to translate yudit messages to my language
==============================================

1. cd gui
2. mkdir -p locale/country_and_variant/LC_MESSAGES/
3. make messages
4. yudit -e utf-8 locale/country_and_variant/LC_MESSAGES/messages.po
5. make messages
6. make install
7. mail -s locale/country_and_variant \
     gaspar@yudit.org < locale/country_and_variant/LC_MESSAGES/messages.po
8. add 
    yudit.default.language=country_and_variant
   to ~/.yudit/yudit.properties
   you may want to add:
    yudit.default.font=yourfont
    yudit.default.fontsize=yourfontsize
  A good result can be achieved if you download and install the 

   http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz

  - mkdir x11fonts   (or re-use .yudit/fonts)
  - cd x11fonts
  - wget http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
  - tar xfz ucs-fonts.tar.gz
  - xset fp+ ~/x11fonts 
  - (optional) put the line above into ~/.Xinitrc
  - change ~/.yudit/yudit.properties

         yudit.default.font=Misc
         yudit.default.fontsze=15

9. Sometimes you may have a translation but it does not appear.
  Possible and not obvious reasons:
  - if the original message has \n at the end the translation should
    have it too.
  - if you see the fuzzy keyword in a comment preceding the message
    it won't be included. Remove the fuzzy comment.

Hunspell spell-checker support
=============================
Type the following in command area of Yudit:

  howto syntax

This will show how Hunspell can be used within Yudit.

     
Japanese Input
==============
For later versions fo  Ubuntu use
   x-ibus:en_US.utf-8
which is available in kmap configuration window.

For archaic old versions you can use other input methods,
basically anything that is in the
  yudit.editor.xinputs=
configuration.

A sample configuration has:
yudit.editor.xinputs=fcitx:en_US.utf-8,ibus:en_US.utf-8,SCIM:en_US.utf-8,interxim,utf-8:en_GB,utf-8:hu_HU,kinput2:ja_JP.eucJP,xcin:zh_TW.big5,Ami:ko_KR,xcin-zh_CN.GB2312:zh_CN.GB2312

Hangul Input
============
Yudit comes with kmap files for Roman transliteration, 2-set and 3-set
keyboards. I expect yudit to improve on this area.

Adding New Mappings
===================
Please read the man page for mytool. FAQ.TXT also has some information.
For clues on how to create an Handwriting input please read the
mytool/hwd/hiragana.hwd utf-8 encoded file, or the same file in
/usr/share/yudit/data/hiragana.hwd.

Undocumented Features
=====================

There is a Yudit command-area command 

  configure

that brings up the configuration file.
When the configuration file is edited, Yudit will not save 
the current settings when it exits, so that you can save 
the config file safely. (Unless another editor session is 
running...)

This is documented: you should know that you can use
the keyboard maps as text converters. So you convert a 
Devanagari transliterated text into unicode like this:

uniconv -decode Devanagari < in_itrans.txt > out_utf8.txt

There are many converters for ISCII character conversion
written by Anirban Mitra <mitra_anirban@yahoo.co.in> and
included in this Yudit package. They all start with IS_.

There is a plan to make a more extensive documentation but
there are too many features and not enough time :)

Acknowledgements
================
Yuko INUI / 乾優子 for her support, and her hiragana and katakana 
handwriting data.
Andrew Weeks at the University of Bath for releasing his True Type 
  to postscript (ttf2pfa) program.
Anirban Mitra <mitra_anirban@yahoo.co.in> Indic (Bengali), IS_XX.mys 
  transliteration maps.
Grisha Mokhin <mokhin@bog.msu.ru> Tibetan support.
Hosszú, Gábor <hosszu@Nimrud.eet.bme.hu> Old Hungarian Support
Németh László nemeth (at) OpenOffice.org  - his hunspel can be used
in yudit as an external spell checker. See 'howto syntax' document
Jungshik Shin <jshin@pantheon.yale.edu> Korean support
Jim Breen <jwb@dgs.monash.edu.au> for the extensive tests and
 bug reports.
Mark E. Shoulson <mark@kli.org> for helping to test the 
  diactritical marks.
Maarten van Gompel <proycon@anaproy.homeip.net> 
  - syntax highlighting, word wrapping and other fixes
Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk> for the unicode FAQ and the good
  advise.
Mohammed Elzubeir <elzubeir@fakkir.net> for helping me with Arabic.
Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com> for the
 huge amount of help in many scripts.
Peter Soos <sp@osb.hu> - cp-1251 encoded vector font (TTF).
Raphael Finkel <rfinkel@mail.csse.monash.edu.au> - extensive debugging
Rajkumar S. <raj2569@yahoo.com> - Malayalam, contributor of dc-font.ttf
Ričardas Čepas <rch@richard.eu.org> - FreeBSD port
Robert Wells for JStroke
Roman Czyborra <czyborra@dds.nl> kmap files, web-page, unifont
Thomas Wohlfarth <thomas.wohlfart@usa.net>, <thomas.wohlfarth@gmx.net> 
  - translations, tests
Thuraiappah Vaseeharan <t_vasee@yahoo.com> for his help and contributions
 to Tamil in Yudit. 
Richard Tebb <richard.tebb@convergys.com> - for 'remote debugging' on Sparc
Todd David Rudick for his program JavaDict, and the kanji hwd.
Tony Laszlo <laszlo@gol.com> - extensive debugging of Yudit.
Mike Fabian mfabian (at) suse.de for his help
...
and you...

==============================================================================
Gáspár Sinai <gaspar@yudit.org>
Tokyo 2023-01-07
