HACKING.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 18 Sep 2014 01:51:07 +0300
changeset 77 c2bad6178c65
parent 57 README.rst@94e1b2d0bd31
child 87 3fa365b14c66
permissions -rw-r--r--
Add project docs.

.. include:: header.rst

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

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

.. include:: VERSION.rst

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