Skip to content

Commit 19fc0b7

Browse files
Update track docs for OCaml 5.x (#547)
1 parent d9e9a8f commit 19fc0b7

File tree

2 files changed

+27
-19
lines changed

2 files changed

+27
-19
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ notes contain a few details specific to Ocaml.
1313

1414
### Local setup
1515

16-
**Prerequesites**
16+
**Prerequisites**
1717

18-
* OCaml `5.1`
19-
* opam
20-
* make
18+
- OCaml `5.1`
19+
- opam
20+
- make
2121

2222
```sh
2323
git clone https://github.com/exercism/ocaml.git
@@ -41,12 +41,11 @@ make test
4141
<details>
4242
<summary>Container setup</summary>
4343

44+
**Prerequisites**
4445

45-
**Prerequesites**
46-
47-
* VSCode
48-
* VSCode Remote Containers extension
49-
* Docker
46+
- VSCode
47+
- VSCode Remote Containers extension
48+
- Docker
5049

5150
```sh
5251
git clone https://github.com/exercism/ocaml.git
@@ -71,7 +70,7 @@ make test
7170

7271
## Adding an Exercise
7372

74-
The [contributing guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md) provides guidance on
73+
The [contributing guide](https://github.com/exercism/docs/blob/main/building/tracks/README.md) provides guidance on
7574
how to add a new exercise, or port an existing exercise from another language track.
7675

7776
This is a brief guide, with specifics for the OCaml track.
@@ -120,6 +119,6 @@ You should base your tests off this data, in order to provide consistency across
120119

121120
If you find this documentation is inaccurate or incomplete, or can be improved in any way, please don't hesitate to raise an [issue](https://github.com/exercism/ocaml/issues) or submit a pull request.
122121

123-
124122
### OCaml icon
123+
125124
The [OCaml](https://ocaml.org) logo is released under the [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license.

docs/INSTALLATION.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,27 @@ To work on the exercises, you will need these pieces of software:
1515
opam switch
1616
```
1717

18-
Switch to that version. If, for example, the latest version is 4.08.0, you will run:
18+
If you already have a switch for OCaml 5.1, either load that by running `opam switch <switch-name>`, or create a new switch by running:
1919

2020
```bash
21-
opam switch 4.08.0
21+
opam switch create exercism 5.1.1
2222
```
2323

24-
3. Install extended standard libraries and test libraries
24+
The name `exercism` here is optional, but naming your switches is a good practice.
2525

26-
Some exercises use only the OCaml standard library, and some use the
27-
extended libraries by Jane Street called Base and Core\_kernel.
26+
3. Install extended standard libraries and test libraries
2827

29-
The test library is called OUnit, and some exercises additionally use the
30-
QCheck library for property-based tests.
28+
Run the following to install the dependencies required by this track:
3129

3230
```bash
3331
opam install base core_kernel ounit qcheck
3432
```
3533

36-
4. Install and use interactive shell
34+
Some exercises use only the OCaml standard library, and some use the extended libraries by Jane Street called Base and Core_kernel.
35+
The test library is called OUnit, and some exercises additionally use the QCheck library for property-based tests.
36+
Running the above command will install these libraries.
37+
38+
4. Install and use interactive shell (optional)
3739

3840
A summary of [Setting up and using `utop`](https://dev.realworldocaml.org/install.html):
3941

@@ -48,3 +50,10 @@ To work on the exercises, you will need these pieces of software:
4850
#require "base";;
4951
open Base
5052
```
53+
54+
5. Install tools in VS Code (optional)
55+
56+
If you use VS Code:
57+
58+
- Install the OCaml language server from [here](https://github.com/ocaml/ocaml-lsp).
59+
- Install the OCaml VS Code extension from [here](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform), or search for `OCaml Platform` by Ocaml Labs.

0 commit comments

Comments
 (0)