
Association Subscribers Manager - 3.1
-------------------------------------------------------------------------

! PLEASE SEE THE "Bug report / requests" SECTION AT THE END OF THIS FILE !
Your feedback is really important for us !

Association Subscribers Manager is a software to manage association members. The "association" term is used in the way of club, sorority or any organization of people.
It is designed for club like sports, cultural or arts clubs for example. It can manage quite wide associations (tested up to 10 000 without problem).

Find Association Subscribers Manager on the Internet :
-----------------------------------------------------------

* Website :
http://www.associationsubscribersmanager.org

* blog :
http://www.infinityperl.org

* Twitter :
http://twitter.com/search?q=#AssumaProject

Bug report / requests :
----------------------------------
You can report bugs directly on Sourceforge's tracker :
http://sourceforge.net/tracker/?group_id=211536

You can also use the assuma-contrib mailing list. You can register on Sourceforge :
http://sourceforge.net/mail/?group_id=211536

License :
-------------

 Copyright (C) 2009 by Arnaud Dupuis
 a.dupuis@infinityperl.org
 http://www.infinityperl.org

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the
 Free Software Foundation, Inc.,
 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA

Requirements :
-----------------------

 - A working C++ compiler,
 - Qt 4.6.0 or higher
 - An operating system compatible with Qt.

/!\ Warning :
-------------

Later in this document, we refers to Qt 4 softwares or build tools. On your GNU/Linux distribution, the "-qt4" suffix might be present in the tool's name.
So "lrelease" might be called on your system "lrelease-qt4", "qmake" might be called "qmake-qt4", etc.

A word on the "Got to YouTube video tutorial channel" feature :
---------------------------------------------------------------

This menu entry opens the Association Subscribers Manager's help browser (wich is a minimalist web browser) on http://www.youtube.com/group/associationmanager.
This page will display correctly only if you have a working Flash installation (and only if your computer is connected to the Internet) ! Please take care of this. 

Install (from sources) :
-------------------------

First, generate translations files with:
     ~$ lrelease association_subscribers_manager.pro
    
Then you have to build the software with the standard Qt process :

     ~$ qmake association_subscribers_manager.pro
     ~$ make

By default, the build process is configured to install all files with the /usr/local/ prefix. To change this, just call qmake with an INSTALLDIR option :
     ~$ qmake INSTALLDIR=/usr association_subscribers_manager.pro
Please see bellow for a list of installed files.

Also by default, the updater related code is not compiled on GNU/Linux or Mac OS X platforms (but it is compiled by default for Windows platforms). The reason is that this feature may comes in the way of GNU/Linux distributions' own packaging systems. Mac OS X is not yet officially supported by myself or by nobody I am aware of, so the updater cannot updates this OS. If you want to include this feature in your build of Association Subscribers Manager, you have to run qmake this way :
     ~$ qmake ASSUMA_UPDATER=1 association_subscribers_manager.pro

To compile with debug support (generates lots of messages on the console output), you have to use:
     ~$ qmake ASSUMA_DEBUG=1 association_subscribers_manager.pro

If needed, packagers can modify directly the project file (association_subscribers_manager.pro) to feet their exact needs.

Once the build process is done, install Association Subscribers Manager with (if you have configured sudo):
     ~$ sudo -c "make install"
Else do:
     ~$ su
     Password:
     ~# make install

And then you can start the program with :
     ~$ association_subscribers_manager
     
Optionnally you can generate the API documentation :
     ~$ doxygen Doxyfile

The present source package is a snapshot of the SVN tag 3.2.

Installed files :
-----------------

By default, all files are installed in /usr/local on GNU/Linux based system, C:\Program Files\AssociationSubscribersManager on windows and /Applications on Mac OS X. This is called the INSTALLDIR.
The data directory is installed in INSTALLDIR/share/AssociationSubscribersManager.
Headers are installed in INSTALLDIR/include.
The images directory is installed in INSTALLDIR/share/AssociationSubscribersManager/images.
The documentation directory is installed in INSTALLDIR/share/AssociationSubscribersManager/doc.
The themes directory is installed in INSTALLDIR/share/AssociationSubscribersManager/themes.
The translations directory is installed in INSTALLDIR/share/AssociationSubscribersManager/i18n.
