FRESH MEMORY

Fresh Memory is a tool for studying and refreshing foreign words. It manages a set of dictionaries and performs various word tests: Flash cards, Multiple choice, etc.

DESCRIPTION
=============================

Fresh Memory is an educational tool for studying foreign words or terms from a specific domain. The application manages a set of dictionaries, which can be loaded, created, modified and saved. The user can take several types of tests on basis of the loaded dictionary. The main tests are:
- Flash cards
- Multiple choice test.
These tests will help to memorize new words or refresh old ones. The application works with Unicode characters (UTF-8) and therefore is not restricted to Latin letters.
The supported OSes are Linux and Windows. Also the project can be theoretically compiled under MacOS, as QT is used for its graphical interface.
 
This application makes powerful use of Object-oriented programming with C++ and the QT graphical library. All windows are implemented with Model-View-Controller pattern. The QT's built-in Model/View programming capabilities are used for displaying dictionaries in a table form. Other patterns that were used in this software are: Factory, Singleton. The source code was written with internationalization in mind. All string data used in the program can be easily translated to other languages using the standard QT internationalization tools.


COMPILATION REQUIREMENTS
=============================

The source code can be compiled for Linux, Windows and MacOS.

Linux:
- qt >= 4.2
- gcc
- make

Windows:
- qt >= 4.2
- MinGW


COMPILATION
=============================

    qmake
    make release

Some Linux distributions (e.g. Ubuntu) will require to use explicit command "qmake-qt4" instead of "qmake", when the development packages of both qt-3 and qt-4 are installed.


INSTALLATION
=============================

    make release-install

Linux: Use the root or sudo environment.


DOCUMENTATION
=============================

The project documentation is available as the Doxygen automatically generated documentation from the source code. To generate it, just type:

    doxygen

This requires the following packages:
- doxygen
- graphviz

Start browsing the documentation from:
    doc/doxy/html/index.html


USAGE
============================

freshmemory [OPTIONS] [FILE]

Argument FILE is a dictionary filename to be loaded.

Options:
    --version, -v       Prints version information and quits.
    --help, -h          Prints help page and quits.


WEBSITE
=============================

See Fresh Memory website for more information:

    http://freshmemory.sourceforge.net
    