Read Me

############################################################################################################
# Copyright 2009: Tiago Rodrigues [Azorian] - tiago_rodrigues@users.sf.net                                 #
# This code is provided under the GPLv2                                                                    #
############################################################################################################

* This project aims to provide a fully functional GUI [and command line] interface to control the
"USB LED Message Board v1.0" HW, by dreamcheeky. It allows local and remote multi-user control using TCP sockets.

* Main Features:

- Server/Client model: allows multiples users/multiple instances to be run at the same time,
  on the same machine/over the network
- Gui/Command line modes: command line clients can be run from scripts that interface with the server.
  Gui interface allows interactive user control
- GUI Client Interface: allows view of current server state, queue new text/images to scroll, delete existing queued items.
- GUI Server Interface: allows management of current user list
- GUI font editor: allows creation of custom character fonts
- GUI image editor: allows the creation of bit images that can be sent to the display
- Cross platform: Windows/Linux supported

* Release history:

    31/03/09 - First public release.
     - Win32/Linux versions are mostly feature complete
     - Still some outstanding issues with the GUI on the Linux version:
       open/save dialogs causing segmentation faults inside QT

* Building the source:

    Under Win32:

    - you'll need visual studio [used VS 2005 - express edition]
    - you will need to get QT [used opensource version 4.4]: compile it and point $QTDIR to the root of your installation
    - just open the project file "Platforms\Win\LedDisplayControllerGui.vcproj" and build the desired configuration

    Under Linux:

    - you'll need an up to date version of GCC [used 4.3.3]
    - you'll need to get QT [used opensource version 4.4]: compile and install
    - you'll find a make files under "Platforms/Linux/Makefile". Costumize the "MakefileBase" to match your system configuration
    - run make

* Running

    - Running in the fully featured GUI is as simple as running the executable without any command line options.
    - You can run multiple instances on the same machine - only the first instance created will create the server
    - You can run the server without any GUI by passing the option: "-NoGui"
    - You can run a non interactive client by passing the options "-NoServer -NoGui" followed by any additional options such as:
            "-SendText "text to send" "
            "-DeleteRegex "regular expression of the item description to delete" "