Document installation and running for OCaml

This commit is contained in:
Maiste 2023-10-20 09:24:25 +02:00
parent 5f97fd6e34
commit 70eba3e2b0
No known key found for this signature in database
GPG Key ID: 030C4ED753794A0E

30
ocaml/README.md Normal file
View File

@ -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
```