mirror of
https://github.com/emilybache/GildedRose-Refactoring-Kata.git
synced 2025-12-12 04:12:13 +00:00
Document installation and running for OCaml
This commit is contained in:
parent
5f97fd6e34
commit
70eba3e2b0
30
ocaml/README.md
Normal file
30
ocaml/README.md
Normal 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
|
||||||
|
```
|
||||||
Loading…
Reference in New Issue
Block a user