Skip to content

Commit

Permalink
Document installation and running for OCaml
Browse files Browse the repository at this point in the history
  • Loading branch information
maiste committed Oct 21, 2023
1 parent 5f97fd6 commit 70eba3e
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions ocaml/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Gilded Rose Kata for OCaml

### Requirements

To run the project, the following package must be available on your computer:
- `opam` `>= 2.0`

### Installation

At the root of the _ocaml_ directory, execute:
```sh
opam switch create . --deps-only
eval $(opam env)
```

It will install all the required dependencies for the project to run.

### Running

This project relies on `dune`. To build it, run this command in your terminal:
```sh
dune exec gilded_rose
```

### Testing

The test suite is built with `Alcostest`. To launch the tests, just type:
```sh
dune runtest
```

0 comments on commit 70eba3e

Please sign in to comment.