Read Me

+-------------------+
| Contents / Inhalt |
+-------------------+
1. English
  1.1 About Unicode Viewer
  1.2 Installation from the sources (Linux)
  1.3 License

2. German
  2.1 Über Unicode Viewer
  2.2 Installation aus den Quellen (Linux)
  2.3 Lizenz

+------------+
| 1. English |
+------------+

  1.1 About Unicode Viewer
  ------------------------
    Unicode Viewer is a tool for browsing Unicode tables to obtain detailed information 
    about every character. It provides functions to navigate through tables by blocks,
    search for single characters or sets and to create custom tables. The GUI is 
    extended by a Lua console that provides a command-line interface and allows the user
    to create new functions. 
    In contrast to other software for this purpose, Unicode Viewer allows you to load
    Unicode tables from the text files published by the Unicode Consortium. Thereby the
    software has the ability to display the sorting weights (collations) for each glyph
    and is developed for the work with these.


  1.2 Installation from the sources (Linux)
  -----------------------------------------
    To install Unicode Viewer from sources, Qt 4.6.2 ( or later ) is required.
    To check if Qt is installed on your system run:

    $> qmake --version

    When Qt is installed, extract the files from the package and run
    the following commands:

    $> qmake        ( Agree to install with "Yes" )
    #> make install ( as root user )

    After the installtion is complete, the software can be started:

    $> UnicodeViewer

    In the integrated user guide you will find instructions for your first steps.

  1.3 License
  -----------
    Unicode Viewer was developed as a project for a bachelor thesis by 
    Martin Burgemeister and Mathis Lindemann under supervision of 
    Prof. Dr.-Ing. Fritz Mehner at the university of applied science
    Südwestfalen, Iserlohn.
    The software is published and developed under the terms of the GNU General Public 
    License ( see License.txt ).


+-----------+
| 2. German |
+-----------+


  2.1 Über Unicode Viewer
  -----------------------

    Unicode Viewer ist ein Werkzeug zum Betrachten von Unicode-Tabellen um
    detaillierte Informationen zu jedem Zeichen zu erhalten. Die Software
    bietet Funktionen zum Navigieren durch die Tabellen über
    Unicode-Blöcke, zum Suchen nach bestimmten Zeichen und zum Erstellen 
    eigener Tabellen an. Die grafische Benutzeroberfläche wird durch eine 
    Lua-Konsole erweitert, die als Kommandozeile dient und es erlaubt neue 
    Funktionen zu erstellen. 
    Im Gegensatz zu anderen verfügbaren Programmen zu diesem Zweck, ermöglich 
    Unicode Viewer das Laden der Tabellen aus Textdateien, wie sie vom 
    Unicode Konsortium veröffentlicht werden. Hierdurch bietet die Software 
    die Möglichkeit neben den Kodierungen auch die vorhandenen 
    Sortiergewichte (Kollationen) jedes Zeichens anzuzeigen und soll als 
    Werkzeug für die Arbeit mit diesen dienen.


  2.2 Installation aus den Quellen (Linux)
  ----------------------------------------

    Für die Installation von Unicode Viewer aus den Quellen, wird Qt 4.6.2 ( oder höher ) 
    benötigt. Um zu überprüfen ob Qt installiert ist, führen Sie folgenden Befehl aus:

    $> qmake --version

    Ist Qt installiert, entpacken Sie das Archiv und führen Sie in dem entpackten Ordner 
    folgende Befehle aus:

    $> qmake             ( Mit Yes bestätigen, dass installiert werden soll)
    #> make install      ( Als root )

    Die Software kann nun mit dem folgenden Befehl gestartet werden:

    $> UnicodeViewer

    Die integrierte Benutzerhilfe bietet eine Anleitung für die ersten Schritte mit der 
    Software.


  2.3 Lizenz
  ----------

    Unicode Viewer wurde zunächst im Rahmen einer Bachelorarbeit von Martin
    Burgemeister und Mathis Lindemann unter der Betreuung von Prof. Dr.-Ing. Fritz Mehner 
    an der Fachhochschule Südwestfalen, Iserlohn entwickelt. 
    Die Software wird unter der GNU General Public License (siehe License.txt) 
    veröffentlicht und weiterentwickelt.