Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
charguer opened this issue Jul 3, 2018 · 3 comments
Open

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

charguer opened this issue Jul 3, 2018 · 3 comments

Comments

@charguer
Copy link

charguer commented Jul 3, 2018

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.

@pmetzger
Copy link
Member

pmetzger commented Jul 3, 2018

I think having such information on the web page is an excellent idea (though I'm not against the toplevel.) Perhaps you should craft a Pull Request?

@agarwal
Copy link
Member

agarwal commented Jul 12, 2018

Please see related issues regarding revamping the Tutorials page: #996, #502.

@ghost
Copy link

ghost commented Nov 16, 2020

@patricoferris explore might be close to covering this now. Maybe we can close

avsm pushed a commit to avsm/ocaml.org that referenced this issue Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants