README

**************************************************************************
* Copyright (c) 2009, Romain BARDOU                                      *
* All rights reserved.                                                   *
*                                                                        *
* Redistribution and  use in  source and binary  forms, with  or without *
* modification, are permitted provided that the following conditions are *
* met:                                                                   *
*                                                                        *
* * Redistributions  of  source code  must  retain  the above  copyright *
*   notice, this list of conditions and the following disclaimer.        *
* * Redistributions in  binary form  must reproduce the  above copyright *
*   notice, this list of conditions  and the following disclaimer in the *
*   documentation and/or other materials provided with the distribution. *
* * Neither the  name of Melt nor  the names of its  contributors may be *
*   used  to endorse  or  promote products  derived  from this  software *
*   without specific prior written permission.                           *
*                                                                        *
* THIS SOFTWARE  IS PROVIDED BY  THE COPYRIGHT HOLDERS  AND CONTRIBUTORS *
* "AS  IS" AND  ANY EXPRESS  OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT *
* LIMITED TO, THE IMPLIED  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR *
* A PARTICULAR PURPOSE  ARE DISCLAIMED. IN NO EVENT  SHALL THE COPYRIGHT *
* OWNER OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *
* SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES (INCLUDING,  BUT  NOT *
* LIMITED TO, PROCUREMENT OF SUBSTITUTE  GOODS OR SERVICES; LOSS OF USE, *
* DATA, OR PROFITS; OR BUSINESS  INTERRUPTION) HOWEVER CAUSED AND ON ANY *
* THEORY OF  LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY,  OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING  IN ANY WAY OUT OF THE USE *
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   *
**************************************************************************

More information can be found on:

        http://melt.forge.ocamlcore.org/

Note that there is a Debian package for melt, called ocaml-melt.

Pre-requisites
==============

You need the OCaml compiler.  Version 3.09 is enough, maybe some
previous versions will work too.  Version 3.10.2 is needed if you want
to compile using Ocamlbuild.  Version 3.11 is needed if you want to be
able to use native plugins for the Melt Preprocessor.

To compile Melt documents you need a LaTeX distribution.

To compile Melt documents which use Mlpost figures you need the Mlpost
library. Versions from 0.6 to 0.8.1 are compatible. You will also need
its dependencies, such as Metapost and the "context" package (Ubuntu,
Debian, ...). Mlpost can be found at:

        http://mlpost.lri.fr

You can compile and use Melt without Mlpost, but you will need to
compile your Melt documents using the -no-mlpost option. If you later
install Mlpost and want to use it with Melt you will have to recompile
Melt.

Quick install (OCaml 3.10.2 or more)
====================================

make
make install

Quick install (Without Ocamlbuild)
==================================

make -f noob.makefile
make -f noob.makefile install

Configuration
=============

The configuration tool is automatically launched the first time you
run make. You can rerun it at any time by removing the Config file and
running make again, or by running:

        ocaml configure.ml -i

The -i option activates interactive mode.  If you don't use it,
default values will be used.

You can also edit the Config file by hand.

Documentation
=============

You can compile the documentation of Melt yourself. The manual can be
compiled with:

        cd bench
        melt -pdf doc.mlt

You obtain the file doc.pdf.

The library documentation is automatically compiled when you run
make. It can be found in:

        _build/latex/latex.docdir/index.html
        _build/melt/melt.docdir/index.html

or, if you compiled without Ocamlbuild:

        latex/latex.docdir/index.html
        melt/melt.docdir/index.html

Vim Plugin
==========

Vincent Aravantinos made a Melt plugin for the Vim text editor. You
can find it here:

        http://www.vim.org/scripts/script.php?script_id=2787

Emacs mode
==========

An emacs mode is available in the distribution: emacs-mode.el. To
install it, copy it in your load-path and add:

(require 'melt-mode)

to your .emacs. To add a path to your load-path:

(add-to-list 'load-path "~/path/to/melt-mode/")

Author and contributions
========================

This project was started by Romain Bardou, and received several
contributions from:

  Vincent Aravantinos
  François Bobot
  Pierre Chambart
  Stéphane Glondu
  Arnaud Spiwack