Skip to content

Commit

Permalink
Update REAMDE
Browse files Browse the repository at this point in the history
  • Loading branch information
edwinans committed May 10, 2024
1 parent 841ddd6 commit d5bfe71
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit d5bfe71

Please sign in to comment.