From cf4f118c22ad382d9252433f230035425268554f Mon Sep 17 00:00:00 2001
From: Vladan Popovic <vladanovic@gmail.com>
Date: Sat, 13 Jan 2024 12:29:47 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aed8681
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# OCaml exercism exercises
+
+To set up the envirnoment run:
+```bash
+nix develop
+```
+
+To test a single exercise with dune:
+```bash
+dune test hello-world
+```
+
+## Configuring the exercism CLI
+
+First, get a token from exercism, than run:
+```bash
+exercism configure --token <token> --workspace /home/vladan/dev/exercism
+```
+
+## Using the exercism CLI
+
+Download an exercise:
+```bash
+exercism download --track=ocaml --exercise=hello-world
+```
+
+To test a single exercise open the folder and run test, e.g.:
+
+```bash
+cd hello-world
+exercism test
+```
+
+To submit solutions (from within the exercise folder):
+```bash
+exercism submit
+```