From d5bfe71719bc4a3f5ea197e6184a488c7f359c92 Mon Sep 17 00:00:00 2001 From: edwinans Date: Fri, 10 May 2024 13:49:45 +0200 Subject: [PATCH] Update REAMDE --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index adae943..ebee686 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ # Camel Finder -A variant of the Minesweeper game implemented in `ocaml-vdom` running on the Web. +A camel-style variant of the [Minesweeper](https://en.wikipedia.org/wiki/Minesweeper_(video_game)) game implemented in OCaml and compiled to JavaScript ([js_of_ocaml](https://github.com/ocsigen/js_of_ocaml)), in a functional paradigm ([Elm](https://guide.elm-lang.org/architecture/)) using [ocaml-vdom](https://github.com/LexiFi/ocaml-vdom). Running on a web browser. -## Build -``` -dune build -``` +Play on the [demo page](https://edwinans.github.io/camel-finder/): +- Left-click to expand a cell +- Right-click to find (flag) camels ## Install dependencies ``` opam install . --deps-only ``` +## Build +``` +dune build +``` + ## Easy local run ``` ./run.sh