Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
  • Loading branch information
tmattio and christinerose committed Sep 24, 2022
1 parent 03128f3 commit 3243f1b
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions data/tutorials/gs_03_ocaml_on_windows.md
Expand Up @@ -9,12 +9,12 @@ date: 2021-05-27T21:07:30-00:00

# OCaml on Windows

We recommend installing Opam 2.2 for new users; it comes with full Windows support.
We recommend installing opam 2.2 for new users; it comes with full Windows support.

There are a couple scenarios when other OCaml installers may be useful:

* when you want **to develop applications and either are unfamiliar with Unix or care more about stability and ease-of-use than the latest compiler** you can use [Diskuv OCaml](#diskuv-ocaml)
* when you want **only to run, not develop, applications** you can use [Docker](#docker-images) or [WSL2](#wsl2)
* when you want **to develop applications and either are unfamiliar with Unix or care more about stability and ease-of-use than the latest compiler**, you can use [Diskuv OCaml](#diskuv-ocaml)
* when you want **only to run, not develop, applications**, you can use [Docker](#docker-images) or [WSL2](#wsl2)

The recommendations are based on the availability table below:
* Tier 1 is fully supported with the latest compilers
Expand All @@ -38,18 +38,17 @@ The recommendations are based on the availability table below:

Diskuv OCaml ("DKML") is a distribution of OCaml that supports software development in pure OCaml.
The distribution is unique in its:
* full compatibility with OCaml standards like Opam, Dune and ocamlfind
* focus on "native" development (desktop software, mobile apps and embedded software) through support for the standard native compilers
like Visual Studio and Xcode
* ease-of-use through simplified installers and simple productivity commands; high school, college and university students should be
* full compatibility with OCaml standards like opam, Dune, and OCamlfind.
* focus on "native" development (desktop software, mobile apps, and embedded software) through support for the standard native compilers,
like Visual Studio and Xcode.
* ease-of-use through simplified installers and simple productivity commands. High school, college, and university students should be
able to use it
* security through reproducibility, versioning and from-source builds
* security through reproducibility, versioning, and from-source builds.

To install DKML, briefly review the following:

* You need to **stay at your computer** and press "Yes" for any Windows security popups;
after the DKML installer finishes installing two programs (`Visual Studio Installer`
and `Git for Windows`) you can leave your computer for the remaining one (1) hour.
* You need to **stay at your computer** and press "Yes" for any Windows security popups. After the DKML installer finishes installing two programs (`Visual Studio Installer`
and `Git for Windows`), you can leave your computer for the remaining one (1) hour.

* First time installations may get a notification printed in red. If you see it, reboot your computer and then restart your installation so that Visual Studio Installer can complete. The notification looks like:

Expand Down Expand Up @@ -130,14 +129,14 @@ easier way to get a working Windows environment on your machine.

### Visual Studio Code on Windows

**If you use the recommended DKML installer** you will need to:
**If you use the recommended DKML installer**, you will need to:
1. Go to `File` > `Preferences` > `Settings` view (or press `Ctrl ,`)
2. Select `User` > `Extensions` > `OCaml Platform`
3. **Uncheck** `OCaml: Use OCaml Env`

**If you use WSL2** you will remotely connect to your WSL2 instance from
**If you use WSL2**, you will remotely connect to your WSL2 instance from
Visual Studio Code. Microsoft has a [useful blog post](https://code.visualstudio.com/blogs/2019/09/03/wsl2)
covering getting WSL2 and Visual Studio Code connected.
that covers getting WSL2 and Visual Studio Code connected.

### Vim and Emacs on Windows

Expand Down

0 comments on commit 3243f1b

Please sign in to comment.