You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,11 @@ notes contain a few details specific to Ocaml.
13
13
14
14
### Local setup
15
15
16
-
**Prerequesites**
16
+
**Prerequisites**
17
17
18
-
* OCaml `5.1`
19
-
* opam
20
-
* make
18
+
- OCaml `5.1`
19
+
- opam
20
+
- make
21
21
22
22
```sh
23
23
git clone https://github.com/exercism/ocaml.git
@@ -41,12 +41,11 @@ make test
41
41
<details>
42
42
<summary>Container setup</summary>
43
43
44
+
**Prerequisites**
44
45
45
-
**Prerequesites**
46
-
47
-
* VSCode
48
-
* VSCode Remote Containers extension
49
-
* Docker
46
+
- VSCode
47
+
- VSCode Remote Containers extension
48
+
- Docker
50
49
51
50
```sh
52
51
git clone https://github.com/exercism/ocaml.git
@@ -71,7 +70,7 @@ make test
71
70
72
71
## Adding an Exercise
73
72
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
75
74
how to add a new exercise, or port an existing exercise from another language track.
76
75
77
76
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
120
119
121
120
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.
122
121
123
-
124
122
### OCaml icon
123
+
125
124
The [OCaml](https://ocaml.org) logo is released under the [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license.
Copy file name to clipboardExpand all lines: docs/INSTALLATION.md
+17-8Lines changed: 17 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,25 +15,27 @@ To work on the exercises, you will need these pieces of software:
15
15
opam switch
16
16
```
17
17
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:
19
19
20
20
```bash
21
-
opam switch 4.08.0
21
+
opam switch create exercism 5.1.1
22
22
```
23
23
24
-
3. Install extended standard libraries and test libraries
24
+
The name `exercism` here is optional, but naming your switches is a good practice.
25
25
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
28
27
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:
31
29
32
30
```bash
33
31
opam install base core_kernel ounit qcheck
34
32
```
35
33
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)
37
39
38
40
A summary of [Setting up and using `utop`](https://dev.realworldocaml.org/install.html):
39
41
@@ -48,3 +50,10 @@ To work on the exercises, you will need these pieces of software:
48
50
#require "base";;
49
51
open Base
50
52
```
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