

INSTALL - how to install the development releases of GNU Solfege
****************************************************************

Obtaining
=========

   The latest version is available from
`http://download.sourceforge.net/solfege' or (same server, other look)
`http://sourceforge.net/project/filelist.php?group_id=1465'.

   The tarball is also available at `ftp://alpha.gnu.org/gnu/solfege'.

   The homepage for GNU Solfege is `http://www.solfege.org'.

Configuring and compiling
=========================

     ./configure
     make
     su -c "make install"

   should work, and will install into

       /usr/local/bin
       /usr/local/share
       /usr/local/lib
       /etc/gnome/config/solfege0.7    (/etc/solfege0.7 if you are not running GNOME)

   Use the `--prefix' and `--sysconfdir' command line options to
install elsewhere. For example to install in your home directory:

     ./configure --prefix=$HOME/usr --sysconfdir=$HOME/etc
     make
     make install

--without-gnome
---------------

   You can build Solfege without using the gnome libraries if you give
`configure' the `--without-gnome' command line option.

   This is a ugly stripped down version of Solfege without html support
and without the id-tone exercise and piano and guitar widgets.

-enable-oss-sound, -disable-oss-sound
-------------------------------------

   The default is -enable-oss-sound.

Asking for trouble
==================

   Things not to do:
   * Install more than one version of Solfege at the same time.

   * Run two or more instances of Solfege at the same time.

   * Do not run one version of Solfege from the sourcedir while
     another is installed!

Internationalisation
====================

   For translated messages:
       export LC_MESSAGES=de_DE

   At the moment only incomplete norwegian, german, french and italian
translations exist.

Packaging
=========

   To create a debian package, configure and type "make deb".

   To create rpm and src.rpm package, configure and type make rpm. You
need write access to /usr/src/redhat to do this

Sound issues
============

   Some command line options:
       --sound-using-timidity
       --sound-using-drvmidi
       --external-midiplayer="programname --some --parameters %s"
       --sequencer-device=/dev/devicename (try /dev/sequencer)

   So if you don't get any sound, but you playmidi is working on your
system, you can try `--external-midiplayer="playmidi %s &"'

If it just won't work
=====================

   If you get an errormessage that ends something like this:

         ValueError: computed value for NV_MAGICCONST deviates too much (computed 2,82843, expected 1)

   you need to change the value of the environment variable LC_NUMERIC.
You can run solfege like this:

         LC_NUMERIC=C solfege

   or set the variable in you ~/.bash_profile or ~/.bashrc file:

       export LC_NUMERIC=C

   If your shell is something else than bash, you probably know how to
do this.

Other things to do
------------------

   * Make sure there are no files from an older release confusing
     the program. Make sure you get rid of  ~/.gnome/solfege0.7,
     ~/.gnome/accels/solfege0.7, ~/.solfegerc0.7, ~/.solfege0.7/,
     $sysconfdir/solfege0.7, $sysconfdir/gnome/config/solfege0.7

   * `unset LANG' and maybe `unset LC_ALL' might help if translated
     messages are not up-to-date.

   * check that you have correct versions of libs and python

   * report your problems to solfege-devel@lists.sourceforge.net

   * get a machine that is an exact clone of mine

For compiling you need:
=======================

   * GNU Make

   * Python header files

   * C compiler

   * m4 macro processor (for documentation preprocessing)

Running:
========

   * Python 1.5.2

   * Gtk+ 1.2

   * Gnome >= 1.0.50

   * PyGNOME >= 1.0.50 - Python bindings for GNOME

   * Midi working on /dev/music. Or at least possible to play midi
     files on some external program.

For development
===============

   If you make any changes to the C code in soundcard/, you'll need
   * swig (Simplified Wrapper and Interface Generator) found at
     `http://www.swig.org' to recompile.

