.. include:: header.rst

==================
 2048 game JS AI.
==================
.. contents::

Document version.
=================

.. include:: VERSION.rst

Home page.
==========

SF disallow hosting project with names starting with number. So ``js-2048-ai`` used instead of
``2048-js-ai``.

  http://js-2048-ai.sourceforge.net/
    Home page.
  https://sourceforge.net/p/js-2048-ai/
    SF home page.
  https://sourceforge.net/projects/js-2048-ai/files/
    Releases.

Getting sources.
================

.. code:: console

  $ hg clone http://hg.code.sf.net/p/js-2048-ai/hg 2048-js-ai

Getting help.
=============

See Authors_.

Build docs.
===========

Install reStructuredText text processor - docutils. On Debian:

.. code:: console

  $ sudo apt-get install python-docutils

Build docs:

.. code:: console

  $ make docs

Build jsdoc.
============

.. code:: console

  $ make jsdoc

Refer for JSDoc syntax to:

 * http://usejsdoc.org/
 * https://developers.google.com/closure/compiler/docs/js-for-compiler
 * https://code.google.com/p/jsdoc-toolkit/w/list

Deploy to SourceForge.
======================

Be sure you at Mercurial tagged revision and run:

.. code:: console

  $ make deploy2sf