Some documentation

1. Prerequisites

• Eclipse 3.0 or superior installed. Get it at eclipse.org
• OCaml distribution with working bytecode compiler (ocamlc) and dependency generator (ocamldep). Get the OCaml distribution at the official site. Note that both executables must be in the PATH.

2. Installation

In the Eclipse IDE, select Software Updates | Find and Install under the Help menu. Then select "Search for new features to install"; in the next step, add a New Remote Site pointing to http://eclipsefp.sf.net/ocaml/site.xml which is the OCaml plugin update site. Then select the camlclipse feature and, a few more steps later, you're done.

3. Use

• Creating a new project - Under the File menu, select New | Project, and then when the types of projects appear, select OCaml.
• Adding a new file to the project - Right-click in the src folder and select New | File.
• Building - By default, the project will be incrementally built as you save the source files. You can turn off automatic building in the Project menu, and then explicitly request a build using the Build Project command in the same menu.
• Launching - An executable with name result.exe will be produced in the bin directory after a successful build. To run it in the IDE, select Run... in the Run menu, and create a launch configuration for it. Select the type OCaml Application, create a new launch configuration, select the project that is to be launched, and name the new configuration. Then the same project can be launched from the Run icon (the white triangle in a green background).

4. Caveats

Remember, it's alpha software. Sometimes building the project doesn't work because of faulty dependency calculations. It shouldn't affect small projects, but eventually you'll need to artificially alter some file and rebuild the project. Other, unknown bugs are surely there. Please report any strange behavior in the forums or the list.

Back to the main page for the OCaml plugins