head	1.7;
access;
symbols;
locks; strict;
comment	@# @;


1.7
date	2005.12.20.20.30.40;	author shd;	state dead;
branches;
next	1.6;

1.6
date	2005.12.20.12.32.43;	author shd;	state Exp;
branches;
next	1.5;

1.5
date	2005.12.20.12.28.42;	author shd;	state Exp;
branches;
next	1.4;

1.4
date	2005.12.20.12.25.51;	author shd;	state Exp;
branches;
next	1.3;

1.3
date	2005.12.13.18.33.37;	author shd;	state Exp;
branches;
next	1.2;

1.2
date	2005.12.12.16.26.45;	author shd;	state Exp;
branches;
next	1.1;

1.1
date	2005.12.12.15.45.07;	author shd;	state Exp;
branches;
next	;


desc
@@


1.7
log
@*** empty log message ***
@
text
@General Instructions for Installing UADE
========================================

* Dependencies

Compiling and running UADE requires some libraries depending on which
frontends you want to use:

 Frontend name  | Type           | Dependencies
 ----------------------------------------------
 uade123        | Command line   | libao: http://www.xiph.org/ao/
 xmms		| XMMS plugin	 | XMMS

* Compiling and installation

The installation process has 3 or 4 steps.

(1) ./configure
(2) make
(3) make soundcheck (optional phase)
(4) make install (possibly run as root user)

Longer explanations of these steps follow:

(1) ./configure

  Look at which frontends will be compiled in. In the good case you will see:

  uade123                                 : yes
  XMMS plugin                             : yes
  .. other frontends


  You have the possibility of using many options, such as disabling possible
  frontends (methods for using uadecore through various systems such as the
  command line and XMMS). See ./configure --help for options. Some of the
  more important options are:

	--prefix
	--user

  --user makes uade to be installed into users ~/.uade2/ directory, but of
  course you may issue --prefix=$HOME/something to achieve the same effect.

  It is possible to leavy any uade frontend or even uadecore compiled so that
  packing for distributions is faster and easier. Important options for
  distribution packagers are:

	--package-prefix
	--without-uadecore
	--without-uade123
	--without-xmms

(2) make

  This will build all the components that were configured.

(3) make soundcheck

  You should hear sound if uade123 was compiled in and it works. If uade123
  was not compiled, you may still have success with other frontends such as
  the XMMS plugin. uade123 is only the command line player tool.

(4) make install

  This will install the software. If --user was used the uadecore and frontends
  are installed into ~/.uade2/.


Hints for various GNU/Linux distributions
=========================================

To install necessary dependencies for Gentoo, execute:

	emerge -u libao		(the dependency for uade123)
	emerge -u xmms

In Debian, the required libraries can be downloaded by:

	apt-get install libao-dev xmms-dev

Troubleshooting for Mac OS X
============================

If you are not able to compile uade due to following problem:

	make: `install' is up to date." 

Then please rename this file to INSTALL2 (or something which does not
match any rule name in Makefile). Unfortunately Mac OS X confuses 'make' by
having case insensitive file access. 'make' will think this file is
the result of 'install' rule, which it is not.
@


1.6
log
@*** empty log message ***
@
text
@@


1.5
log
@*** empty log message ***
@
text
@d82 2
a83 2
Note for Mac OS X
=================
@


1.4
log
@*** empty log message ***
@
text
@d89 2
a90 1
Then please rename this file. Unfortunately Mac OS X confuses 'make' by
@


1.3
log
@*** empty log message ***
@
text
@d71 1
a71 1
========================================
d81 11
@


1.2
log
@*** empty log message ***
@
text
@d77 4
@


1.1
log
@*** empty log message ***
@
text
@d1 15
d68 9
@

