Source

clutter-ocaml / README

Clutter-Ocaml
=============

This archive contains the bindings for OCAML for the Clutter toolkit
and clutter-cairo.

If you have any enhancements or bug reports, please send them to:

  rvanmelle@gmail.com

Requirements
------------
  * Ocaml >= 3.10
  * clutter >= 0.8 or higher
  * clutter-cairo >= 0.8 or higher
  * lablgtk2 >= ?? or higher
  * cairo-ocaml >= ??

This release is supporting the following Clutter releases:

        clutter-core    0.8
	clutter-cairo   0.8

Installation
------------

In order to install this module type the following.  This will build both
the byte and native versions of the libraries, tests, and examples.

  autoconf
  ./configure
  make
  make install

To build byte only versions:
  make byte

To build native only versions:
  make native

To generate HTML documentation in clutter-ocaml/doc/html :
  cd src
  make doc

Additional relavant make targets include: all, clean, uninstall

Usage
-----

If you use ocamlfind, you should be able to compile a simple ocaml-clutter
file called "test-clutter.ml" as follows:

  $ ocamlfind ocamlopt -package clutter -c test-clutter.ml
  $ ocamlfind ocamlopt -linkpkg -package clutter -o test-clutter.opt test-clutter.cmx -cclib "`pkg-config --libs clutter-0.8`" -cclib "`pkg-config --libs clutter-cairo-0.8`"

Example clutter script:

open Clutter
let () = 
    let stage = ClutterStage.get_default () in
    stage#show_all;
    clutter_main ()

Copyright and License
---------------------

Copyright (C) 2008  Reid van Melle 

This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Library General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version

This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU Library General Public License for more
details.

You should have received a copy of the GNU Library General Public License along
with this library; if not, write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA  02111-1307  USA.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.