Skip to content

Commit 59a8c2c

Browse files
authored
Fix typos in Up and Running documentation (ocaml#505)
1 parent 56d6b55 commit 59a8c2c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

data/tutorials/gs_00_up_and_running.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ your favourite text editor or IDE. These instructions work on Unix-based systems
1818

1919
It's a straightfoward process to install OCaml. [Opam](https://opam.ocaml.org/) is OCaml's package manager, so we'll install it first. You will also use Opam when installing third-party OCaml libraries.
2020

21-
Find the all installation instructions for both Unix-like systems and Windows below. If you're new to the CLI, the code blocks (in black) shows the required command (the text after # gives more information on the following commands). Type each command after the prompt $, although it's often represented by a %, >, or another symbol as well. Ensure you use the exact case and spacing shown, then hit return/enter at the end of every line.
21+
Find the all installation instructions for both Unix-like systems and Windows below. If you're new to the CLI, the code blocks (in black) show the required commands (the text after # gives more information on the following commands). Type each command after the prompt $, although it's often represented by a %, >, or another symbol as well. Ensure you use the exact case and spacing shown, then hit return/enter at the end of every line.
2222

2323
### Installation for Linux and macOS
2424

@@ -39,7 +39,7 @@ Linux (e.g `apt-get install opam` or similar). [Details of all installation
3939
methods.](https://opam.ocaml.org/doc/Install.html)
4040

4141
**Install Compiler**
42-
It's essential to install the OCaml compiler because OCaml is a compiling language, so please don't skip this step. The first part sets up Opam, and the second part installs the OCaml base compiler:
42+
It's essential to install the OCaml compiler because OCaml is a compiled language, so please don't skip this step. The first part sets up Opam, and the second part installs the OCaml base compiler:
4343

4444
```
4545
# environment setup
@@ -58,7 +58,7 @@ After the `opam init` command, you might get a result asking if you'd like to up
5858

5959
**Please note**: The back ticks shown around `opam env` after `eval` are essential. They change the order of application, which is very important. The back ticks tells the system to first evaluate `opam env` (which returns a string of commands) and then `eval` executes those commands in the string. Executing them doesn't return anything, but it initializes the Opam environment behind the scenes.
6060

61-
Check the installation was successful by running `opam --version`. Please note, merely using `opam init` might install a previous version of Opam. The most current version can be found at [opam.ocaml.org](https://opam.ocaml.org/packages/ocaml-base-compiler/).
61+
Check that the installation was successful by running `opam --version`. Please note merely using `opam init` might install a previous version of Opam. The most current version can be found at [opam.ocaml.org](https://opam.ocaml.org/packages/ocaml-base-compiler/).
6262

6363
The OCaml base compiler installation uses the `opam switch create` command; `switch` is used to have several installations on disk, like packages, compiler version, etc. Specify which version at the end as shown above, i.e., 4.14.0. All possible compiler versions can be found with `opam switch list-available`.
6464

@@ -194,24 +194,24 @@ Now, we install the OCaml Platform Visual Studio Code extension from the Visual
194194
Studio Marketplace.
195195

196196
Upon first loading an OCaml source file, you may be prompted to select the
197-
toolchain in use: pick OCaml the version of OCaml you are using, e.g. 4.11.1
197+
toolchain in use: pick the version of OCaml you are using, e.g. 4.11.1
198198
from the list. Now, help is available by hovering over symbols in your program:
199199

200200
![Visual Studio Code](/media/tutorials/vscode.png)
201201

202202
**On Windows using WSL2** you will remotely connect to your WSL2 instance from
203-
Visual Studio Code. Microsoft have a [useful blog post](https://code.visualstudio.com/blogs/2019/09/03/wsl2)
203+
Visual Studio Code. Microsoft has a [useful blog post](https://code.visualstudio.com/blogs/2019/09/03/wsl2)
204204
covering getting WSL2 and Visual Studio Code connected.
205205

206-
**On Windows**, we must launch Visual Studio Code from within the Cygwin window,
207-
rather than by clicking on its icon (otherwise, the language server will not be
206+
**On Windows** we must launch Visual Studio Code from within the Cygwin window,
207+
rather than by clicking on its icon (otherwise the language server will not be
208208
found):
209209

210210
```
211211
$ /cygdrive/c/Users/Frank\ Smith/AppData/Local/Programs/Microsoft\ VS\ Code/Code.exe
212212
```
213213

214-
**For Vim and Emacs**, install the [Merlin](https://github.com/ocaml/merlin)
214+
**For Vim and Emacs** install the [Merlin](https://github.com/ocaml/merlin)
215215
system using opam:
216216

217217
```

0 commit comments

Comments
 (0)