Skip to content

Tutorial page would benefit from a visible "install" section #1007

Open
@charguer

Description

@charguer

On the page "https://ocaml.org/learn/tutorials/"
there is no occurence of the word "install", nor "ide", nor "editor".

At the moment, the "Learn" page links for the installation directly to https://ocaml.org/docs/install.html
which gives no hint on what to do for setting up a proper IDE to work on ocaml files.

I would suggest to split the "getting started / basics" bullet from the tutorial in several bullets:

  • how to try ocaml online without installing anything
  • how to install ocaml and configure your editor
  • how to compile your first program

The "install ocaml" part would explain opam installation vs package manager installation, and explain tuareg/merlin modes, and a few words on syntax highlight for other editors.

The "how to compile" would show how to compile/execute hello_world.ml, and also would give a basic example of how to compile a two file projects that depends on a library (e.g. str.cma), using "ocamlbuild", or "dune", or "ocamlc" by hand.

PS: I would furthermore personally encourage not to introduce the ocaml command line toplevel. This is just a complete waste of times for students who get started using this thing, and spend hours working without a proper IDE.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions