fresh/doc

/*! \mainpage Fresh - A Qt extension library

Introduction

Fresh is a Qt extension library.

As an extension library it add usefull \ref FreshCore and \ref FreshGui classes to extend the possibilities offered by the excellent Qt.
It runs on any operating system supported by Qt (eg. Windows, UNIX/Linux, MacOS/X).

This documentation describes Fresh for Qt 4.

Fresh also includes language bindings for Python.
These require that PyQt v4 is also installed.

This version of Fresh is based on Qt v4.7.1.

Licensing

Fresh is licensed under the GNU Lesser General Public License v3.
And allow both closed and open source applications to use it.

See the file "LICENSE" to see what license this copy of Fresh is released under.

Installation

As supplied Fresh will be built as a static library and installed in the Qt installation folder.

To build Fresh, run:

    qmake fresh.pro
    make
    sudo make install

If you have both Qt v3 and v4 installed then make sure you use the correct version of qmake.

Depending on the compiler you are using you may need to run nmake rather than make.

Once installed, use it that way in your project:

    CONFIG *= fresh_static

You can replace fresh_static by fresh_shared if you built Fresh in shared mode.

Example Application

The example application provided demonstrate nearly all available classes in Fresh.

To build the example, run:

    qmake subdirs.pro
    make

On Windows (and depending on the compiler you are using) you may need to run nmake rather than make.

Python Bindings

Library has Python bindings, which allows you to use it in your Python aplicaton.
The Python bindings are in the Python directory.
There are next dependencies for Python bindings:
- C++ compiler (Ubuntu package g++)
- Qt4 library v4.7, headers and tools. (Ubuntu packages qt4-qmake, libqt4-dev)
- PyQt4 including development files (Ubuntu packages python-qt4, python-qt4-dev)
- SIP (http://www.riverbankcomputing.co.uk/software/sip/download) (Ubuntu package python-sip-dev)

The configure, build and install library and bindings

	mkdir build
	cd build
	cmake ..
	make all
	make install

The last command requires root privileges

Executing Python example:

	cd examples/python
	python freshexample.py

Qt Designer Plugin (not yet available)

Fresh includes an optional plugin for Qt Designer that allows Fresh widgets to be included in GUI designs just like any other Qt widget.

To build the plugin on all platforms, make sure Fresh is installed and then run (as root or administrator):

    qmake designer.pro
    make
    make install

On Windows (and depending on the compiler you are using) you may need to run nmake rather than make.
*/