Commits

Philip Xu  committed 3111eb1

Added readme

  • Participants
  • Parent commits 5a5de57

Comments (0)

Files changed (1)

+=============
+2048 in OCaml
+=============
+
+
+Introduction
+============
+
+A clone of `2048`_, implemented in `OCaml`_.
+
+.. _2048: https://github.com/gabrielecirulli/2048/
+.. _OCaml: http://ocaml.org/
+
+
+Features
+--------
+
+- GUI with no external dependency
+- Text (ascii) output as well
+- Game play actions implemented as *monadic functions*, for example, to place
+  two new tiles:
+
+  .. code:: ocaml
+
+    playing coard >>= spawn >>= spawn
+
+
+Requirements
+============
+
+To compile
+
+- `OCaml`_ 4.01 or newer.
+
+
+Installation
+============
+
+Compile from source
+
+.. code:: bash
+
+  make
+
+Install
+
+.. code:: bash
+
+  make install
+
+
+License
+=======
+
+BSD New, see LICENSE for details.
+
+
+Links
+=====
+
+Project:
+  http://xrefactor.com/projects/2048.ml
+
+Issue Tracker:
+  https://bitbucket.org/pyx/2048.ml/issues/
+
+Mercurial Repository on Bitbucket:
+  https://bitbucket.org/pyx/2048.ml/
+
+Git Repository on Github:
+  https://github.com/pyx/2048.ml/