README

=== Overview ===

TryOCaml is the easiest way to learn how to code in OCaml language. A
funny way to learn the language. It is available here:

http://try.ocamlpro.com/

TryOCaml is based on
(http://ocsigen.org/js_of_ocaml/files/toplevel/index.html) built with
js_of_ocaml (see http://ocsigen.org/lwt/).

=== Requirements ===

  * Findlib
  * Lwt (version 2.3.0** at least, see http://ocsigen.org/lwt/)

=== Try it ===

0: make

Then, with your favorite browser launch tryocaml/index.html:

1: chromium-browser tryocaml/index.html

=== Contribute lessons/steps/fixes ===

Lessons are in the "lessons/" top directory.

Each lesson is a sub-directory "lessonN", where N is the lesson
number, and contains a file "lesson.html", with a title in a <h3> tag
on the first line, and a set of steps. Each step is a sub-directory
"stepM" of "lessons/lessonN", where M is the step number in the
lesson.

Each step is composed of two files:
- "step.html": the text of the step. The first line MUST contain the step title,
 in a <h3> tag. Code that should be copied in the terminal should be in
 <code> tags.
- "step.ml": the function testing if the step has been completed. It takes
 the user input (a string) and the compiler output (a string) as arguments,
 and returns a boolean, true if the user has succeeded, false otherwise.
 "step.ml" can directly use functions defined in "lessons/goodies.ml"
 (that is included, so NEVER use "open Goodies" or "Goodies.something),
 in particular the "find_in" function.

To recompile when you have done a modification:

$ make update-lessons

Failure to comply to the lesson/step specification will make the
tryocaml/tutorial/make_lessons command fail.

If you want to debug at some point, you can type "debug true" in
the terminal to see what the input and output strings are.

Once everything works, send a "pull request" via Github, or send us a
patch. You can also come on #ocamlpro IRC channel to discuss with us.

=== Online ===
http://try.ocamlpro.com/