Read Me

What is it ?
============

This software is a plugin for Xcode, adding native support for the OCaml langage in Xcode.

It supports :
- source code highlighting (.ml, .mli, .mll and mly files)
- Xcode look & feel to manage a project
- writing pure OCaml programs
- calling C code from OCaml programs
- build native or bytecode programs
- support for ocamllex and ocamlyacc

How to install ?
================

Copy "OCaml.pbplugin" to "~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/"
Copy "Target Templates/*" to "~/Library/Application Support/Developer/Shared/Xcode/Target Templates/OCaml/"
Copy "Project Templates/*" to "~/Library/Application Support/Developer/Shared/Xcode/Project Templates/OCaml/"

Tested with Xcode 3.0 only. Won't work with previous versions.
You must also have installed the ocaml command line tools.

By default, the plugin look for the ocaml compiler at /usr/local/bin.
If the compiler is installed at a different location (like /opt/local/bin),
let the plugin know it by running the following command in a shell :
defaults com.apple.Xcode INOCamlBasePath /opt/local/

How to use ?
============

Easiest way :
- create a new project, using the template "OCaml > OCaml Tool".
- the sample code should compile without any modification.

For non standard situations :
- create an empty projet, or open an existing projet.
- add a new target ("Project" menu), using the template "OCaml > Shell Tool"
- add your ocaml source code files (.ml / .mli / .mly / .mll) to the build phase of this target

To switch between native and bytecode compilation, modify the "Architectures" build settings :
- ocaml = bytecode
- ppc = native code for powerpc macs
- i386 = native code or intel macs

Links
=====

Web site : http://maxao.free.fr/xcode-ocaml-plugin/
Download : http://sourceforge.net/project/showfiles.php?group_id=184878&package_id=215113
SVN repository : http://xcodeplugins.svn.sourceforge.net/svnroot/xcodeplugins/OCamlPlugin
Support mailing list : https://lists.sourceforge.net/lists/listinfo/xcodeplugins-users

Copyright
=========

The source code is published under the GPL v3 licence : you may use it freely as long as you respect
the GPL v3 licence, and mention the initial copyright of its author, Damien Bobillot.

Revision History
================

1.0b11 (Oct 2008) - Mac OS X 10.5.5 compatibility (may not be compatible with previous Mac OS X versions)
1.0b10 (Jan 2008) - Xcode 3.0 compatibility. Add support for nested comments in syntax highlighting, and
                    camlp4 preprocessor
1.0b9  (Dec 2006) - fix a bug preventing to run the compiled executable from Xcode.
1.0b8  (Dec 2006) - Support for ocaml tools at non-standard paths
1.0b7  (Sep 2006) - Some support for source file inter-dependances, support for mixing C & OCaml
1.0b6  (Jun 2006) - Xcode 2.3 & 2.4 & 2.5 compatibility
1.0b5  (Feb 2006) - Xcode 2.2 & 2.2.1 compatibility
1.0b1  (Aug 2005) - First version