-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document installation and running for OCaml
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |