Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

OCamlEditor is a source code editor and build tool for OCaml. It provides many features to facilitate editing code, accessing API reference directly from the editor and compiling projects. It is light-weight, open source and runs under Linux and Windows.

tree: 25af8a9ef9

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 build
Octocat-spinner-32 pixmaps
Octocat-spinner-32 src
Octocat-spinner-32 .gitignore
Octocat-spinner-32 COPYING
Octocat-spinner-32 NEWS
Octocat-spinner-32 README
Octocat-spinner-32 build.ml
Octocat-spinner-32 header
Octocat-spinner-32 ocamleditor.nsi
Octocat-spinner-32 ocamleditor.release.xml
Octocat-spinner-32 ocamleditor.xml
README

                                  OCamlEditor



OCamlEditor is a source code editor and build tool for OCaml.


COPYRIGHT

  This program is distributed under the GNU GENERAL PUBLIC LICENSE Version 3.
  See the enclosed file COPYING for more details.

  The OCamlEditor logo and the icons used are licensed under a
  Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License
  (http://creativecommons.org/licenses/by-nc-nd/3.0/).

  Files "lexical.ml", "gtkThread3.ml" and part of "file.ml" and "shell.ml"
  are copyright 1999 Institut National de Recherche en Informatique et en
  Automatique and Kyoto University.


DEPENDENCIES

  * Objective Caml 3.11.2 with the compiler libraries available from the
    OCaml source distribution;
  * Lablgtk-2.14;
  * Xml-light.


HOW TO COMPILE

  Compile the OCaml source tree, then change to the OCamlEditor toplevel
  directory and edit the "Configuration Section" at the beginning of
  "build.ml", following the comments in that file. Then, do:

    ln -s /path/to/ocaml/compiled/sources src/ocaml-src
    ocaml build.ml

  The name of the command is "ocamleditor.opt" (or "ocamleditor" if the
  native compilation is not supported), you can find it in the "src"
  directory.


HOW TO COMPILE without having to build the entire OCaml source tree
(for example under Windows if you're using the MSVC version of OCaml):

  Edit the "Configuration Section" at the beginning of "build.ml", following
  the comments in that file. Then, do:

    mkdir src\ocaml-src

  Download from http://caml.inria.fr/ the source tarball corresponding to
  your OCaml version installed and copy the directories "utils", "parsing"
  and "typing" to the newly created "ocaml-src" directory; then from the
  OCamlEditor toplevel directory compile with:

    ocaml build.ml -with-compiler-libs

  Under Windows the name of the command is "ocamleditor.opt.exe" (or
  "ocamleditor.bat" if the native compilation is not supperted), you can
  find it in the "src" directory.


INSTALLATION

  For Linux, become superuser and run:

    ocaml build.ml -install [-prefix <path>]

  By default, commands will be installed under "/usr/local/bin" and icons
  under "/usr/local/share/pixmaps/ocamleditor". You can specify an
  installation prefix other than "/usr/local" by giving an absolute file
  name as argument.

  Windows users may build an installer by compiling the included NSIS
  script, "ocamleditor.nsi". The free NSIS install system can be found at
  http://nsis.sourceforge.net


DEVELOPMENT

  The main page for development is hosted on the OCaml Forge, see the
  project's page:

    https://forge.ocamlcore.org/projects/ocamleditor

  The public git repository is hosted on github. You can browse the source
  tree from:

    http://github.com/ftovagliari/ocamleditor

  or clone it by doing:

    git clone git://github.com/ftovagliari/ocamleditor.git


NOTES

  * The most common application settings are accessible from the
    Preferences window, however other options may be changed by editing
    "oe_config.ml" before compiling.
  * The program creates a folder named ".ocamleditor" in your HOME
    directory with informations like preferences, recently opened
    projects, etc.


AUTHOR

  You can report bugs or give feedbacks by e-mail to
  Francesco Tovagliari <ftovagliari@gmail.com>
Something went wrong with that request. Please try again.