From 70eba3e2b04415a4b93aad75c857be3ee9d30f01 Mon Sep 17 00:00:00 2001
From: Maiste <dev@maiste.fr>
Date: Fri, 20 Oct 2023 09:24:25 +0200
Subject: [PATCH] Document installation and running for OCaml

---
 ocaml/README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 ocaml/README.md

diff --git a/ocaml/README.md b/ocaml/README.md
new file mode 100644
index 0000000000..97ef4bfc9c
--- /dev/null
+++ b/ocaml/README.md
@@ -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
+```