====================================================================
      MusE  ---  Linux (Midi) Music Editor
====================================================================

Welcome to MusE, the open source MIDI/Audio sequencer.

MusE is distributed under the GNU General Public License (GPL).
Please check out the file COPYING in this directory for more
details.

,-----------------------------------------------------------------.
| NOTICE                                                          |
|-----------------------------------------------------------------|
| Many parts of MusE code are EXPERIMENTAL, and may well result   |
| in a CRASH, and who knows what other ill effects.               |
| RUN THIS SOFTWARE AT YOUR OWN RISK.                             |
`-----------------------------------------------------------------'

  =============================
      Requirements
  =============================

      - Qt: Qt 3.0.0 or above ( 3.0.1 recommended )
        ftp://ftp.trolltech.com/qt/source
        MusE does _not_ compile with older versions
        Please compile Qt3 with "-thread" option so you get
        the qt-mt.so lib instead of qt.so
      - gcc 2.95.3 (untested with other versions)
    	    Problems are reported with 2.96, so if you're using it
	    you may be unable to run MusE.
      - glibc 2.2.x  (untested with other versions)
      - Linux kernel with rtc (RealTimeClock) driver (device /dev/rtc)
       (apply "low latency patches" for low timing jitter)
      - ALSA from http://www.alsa-project.org/
        checked version 0.9.x 0.6x
        also checked ALSA OSS-Emulation
      - of course: some midi gear
      - (for cvs code) automake 1.5 and autoconf 2.52

  =============================
      Compiling:
  =============================

      - download source from http://muse.seh.de/muse-current-tar.bz2
      - uncompress source:
            bunzip2 muse-current-tar.bz2
      - untar source:
            tar xvof muse-current-tar </code>

      - enter dirctory muse-x.x.x and edit make.inc:
            + Make sure that QTDIR points to the directory
              you installed your qt-libraries and header-files

      - run "qtconfig", open the tab "Library Path" and add the path of
        your installed MusE Sources to the path list;
        This is necessary for the Qt gui compiler "uic" to find the
        MusE specific widget plugins. Without you will get compilation
        errors.

      - run
            make depend (optional if you dont want to modify the source)
            (ignore any errors)
      - run
            make
            (if you installed a root password, make will ask you
            that password in order to set MusE SUID root)
            Note: The executable is suid root to get access to the
                  /dev/rtc device. It is _not_ sufficient to set
                  access rights of /dev/rtc to 0666. Only root can
                  set the necessary hight interrupt rates.
                  Without the real time clock timing will be bad.
                  For best timing you also have
                  to set the -R option to start the sequencer
                  thread with realtime priority.

            Some people reported "undefined symbol errors" due to
            missing header files. This depends on your system
            environment. Please report!

      - test the executable:
        run
            muse demos/rasen.med

      - as root run:
            make install
        to install MusE

  =============================
      some known bugs
  =============================

      Underrun Errors
      Configure your audio device for "play", not for "record" or
      "duplex". Recording is currently not full supported.
      Next set "delay" or "framesize" of your audio device to some
      sane value. A small framesize requires running MusE with
      realtime scheduling turned on ("-R" option). Very small
      values require kernel "low latency patches". This is
      only useful if you want to play the sw synthesizer in
      realtime.

====================================================================
Let me know whether MusE works for you !!!  The address of the
MusE mailing list is muse@seh.de.  Have a look at the
webpage http://muse.seh.de/ for details.

