===========================================
              #####  #####  #####     ##### 
              #      #   #  #   #         #
              #      #   #  #   #         #
#####  #####  #####  #####  #####     #####
# # #  # # #      #  #   #  #         #
# # #  # # #      #  #   #  #         #
# # #  # # #  #####  #   #  #         #####
===========================================


1. Introduction
===============
   mmSAP 2 is SAP (Slight atari player) player based on ASAP library that
   uses ALSA for audio output and GTKmm library for GUI.

   SAP is a special file format that is used to store POKEY-based Atari XL/XE music.
   The biggest collection of such music is ASMA (Atari SAP Music Archive) that 
   can be found at: http://asma.atari.org.

   ASAP library also allows you to load RMT,TMC,TM2,MPT,CMC files directly.

   mmSAP 2 tries to be the best specialized player that takes into account all
   features of the SAP file format.

2. Operating systems supported
==============================
   Modern GNU/Linux distributions.
   There is no support for Microsoft Windows (and it is not planned).

3. Dependencies
===============
   * GTKmm 2.10.X or better, just install gtkmm-devel package.
   * libglade 2.6.X, just install libglade2-devel package
   * ALSA 1.0.X, just install alsa-devel package
   * ASAP 1.2.0, this is bundled in asap-1.2.0 directory
   * libdbus-1 library, just install libdbus-1-devel package
   * libdbus-glib-1 binding library, just install libdbus-glib-1-devel package
   * Correctly configured pkg-config.

4. Compiling and installing
===========================
   * Verify dependencies. Latest stable versions of all
     dependencies are preferred.

   * First, compile ASAP in 'asap-1.2.0' directory:
     ./configure && make lib
     Ignore occasional xmms-devel related warnings
     and check that 'asap.a' file exists

   * Then compile mmSAP 2 itself:

     make CONF="Release"

     It is important to add the CONF="Release" string. As you
     can see, this program is developed using Netbeans 6.1 

   * Binary can be found somewhere in the 'dist' directory,
     you may copy the binary anywhere, it does not depend
     on any data files, good place is /usr/local/bin

   * The ${HOME}/.config directory must exist, in other
     case mmSAP 2 will not be able to save the preferences.
     This directory usually exists (GTK+ uses it and mmSAP2
     uses GTK+)

5. Modifying GUI
================
   * To prevent data loss, use Glade 2.12.2. If you wish to 
     experiment with Glade 3, make backups.

   * GUI is linked into binary. To convert mmsap2.glade to C
     array, you can use for example KHexEdit

6. Planning:
============
   Bugfixes,new features

7. Tested distributions:
========================
   openSuSE 10.3 with GTK+ 2.12.9 compiled from source
   openSuSE 11.0 with bundled GTK+ 

8. Testing is also up to you !
==============================
   If you are interested, test mmSAP 2 on your distribution
   and report bugs using bug tracker at SourceForge. Decent
   feature requests are also welcome.

9. Known problems
=================
   * Seeking works with almost all tunes from ASMA, but not
     with all due to very technical reasons. Look at ASAP
     project home page and complain if you want.

   * Some sound cards do not support mono sound. In this
     case go to 'Preferences' dialog and check the 'Always
     play in stereo' checkbox at card 'ALSA'. This costs
     a little CPU power.

10. Greetings and thanks to
===========================
   * Piotr Fusik
   * Zdenek Eisenhammer
   * All GTK+ and GTKmm developers and contributors