Quick installation procedure (for Unix, including Darwin)
=========================================================

In short, this package uses the standard installation procedure:
unpacking, ./configure, make, make check, make install. This file
describes this with some more details. See the file INSTALL for
generic information on the use of configure.

1.  Unpacking:

	gunzip MuPAD-Combinat-*.tar.gz
	tar xvf MuPAD-Combinat-*.tar
	cd MuPAD-Combinat-*/

2.  Configuration:

	./configure

    If configure does not find MuPAD, or if you want to override the
    default location, you can use something like:

	./configure MUPAD=mupkern

    Here is the complete list of variables you can override:

	MUPAD:		The MuPAD kernel itself
			Default: mupkern
			Don't use a relative path like ../MuPAD/share/bin/mupad
	MUPADdir:	The root directory of MuPAD (i.e. MUPAD_ROOT_PATH)
			Don't use a relative directory like ../MuPAD/
	MUPADbindir:	The directory containing MuPAD's programs
			Default: $MUPADdir/share/bin
	MUPAD_UI:	The MuPAD user interface
			Default: mupad
	MUPAD_MMG:	The module generator for MuPAD
			Default: $MUPADbindir/mmg
	MUPADpkgdir:	Where to install the package
			Default: $MUPADdir/packages/<package>
	MUPADpkgmdmdir:	Where to install the dynamic modules of the package
			Default: $MUPADpkgdir/modules/<sysname>/<version>/
	JAVA		java
	RUBY		ruby
	PERL		perl

    You can disable the dynamic modules if you have trouble compiling
    them; most of the functionnalities of the package will still be
    available:

	./configure --disable-dynamic-modules

    You can enable/disable the building of XML, HTML, or ASCII
    documentation. Extra tools are required for this (cf. README).

	./configure --enable-xml-documentation
	./configure --enable-html-documentation
	./configure --enable-ascii-documentation

3.  Compilation

	make

4.  Tests (optional):

	make check

    The testsuites in test/ are supposed to run cleanly.

    The testsuites in doc/en are supposed to run cleanly with MuPAD >= 3.0.0.
    With earlier versions, they may fail due to different pretty
    printing of semantically equal values.

    Some of the tests *will* fail if dynamic modules are not compiled.

5. Installation (optional):

	make install

    By default MuPAD-Combinat gets installed in
    <MuPADdir>/packages/MuPAD-Combinat.
    Type 'configure --help' for details.

6. Usage:

    With MuPAD >= 2.5.0, and if the package is installed in the standard
    place (see ?PACKAGEPATH), you can simply do:

    >> package("MuPAD-Combinat"):

    Otherwise, you have to specify the full directory where
    MuPAD-Combinat is installed, e.g.:

    >> package("/usr/local/lib/MuPAD/packages/MuPAD-Combinat/"):

    Alternatively, if you skipped the installation step, you can
    specify the directory where MuPAD-Combinat has beed unpacked, say:

    >> package("/home/nthiery/MuPAD-Combinat-1.3.2/"):

    or:

    >> package("."):

7. Getting help:

    >> info(combinat):
    >> info(combinat::partitions):

   The online documentation with ?combinat::partitions works with MuPAD >= 3.2
   as soon as MuPAD-Combinat is installed in one of the standard place
   (see ?PACKAGEPATH)

   The documentation is available in the directory doc/en in XML and
   HTML and in doc/ascii(.tar) in pure text.

8.  That's all folks!