HACKING.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Tue, 31 Jan 2017 03:41:07 +0200
changeset 190 d1b12b602915
parent 181 2252379bcc70
child 193 6d35f7e53b7c
permissions -rw-r--r--
Add swipe support for mobile devises. Fix bug after renaming.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
77
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
     1
.. include:: header.rst
47
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
==================
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
 2048 game JS AI.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
==================
77
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
     6
.. contents::
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
     7
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
     8
Document version.
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
     9
=================
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    10
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    11
.. include:: VERSION.rst
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    12
87
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    13
Home page.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    14
==========
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    15
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    16
SF disallow hosting project with names starting with number. So ``js-2048-ai`` used instead of
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    17
``2048-js-ai``.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    18
181
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    19
  http://2048.defun.work/
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    20
    New home page.
87
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    21
  http://js-2048-ai.sourceforge.net/
181
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    22
    Old home page.
87
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    23
  https://sourceforge.net/p/js-2048-ai/
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    24
    SF home page.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    25
  https://sourceforge.net/projects/js-2048-ai/files/
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    26
    Releases.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    27
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    28
Getting sources.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    29
================
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    30
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    31
.. code:: console
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    32
181
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    33
  $ hg clone http://hg.defun.work/2048-js-ai/ 2048-js-ai
87
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    34
  $ hg clone http://hg.code.sf.net/p/js-2048-ai/hg 2048-js-ai
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    35
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    36
Getting help.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    37
=============
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    38
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    39
See Authors_.
3fa365b14c66 Getting sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 77
diff changeset
    40
77
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    41
Build docs.
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    42
===========
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    43
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    44
Install reStructuredText text processor - docutils. On Debian:
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    45
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    46
.. code:: console
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    47
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    48
  $ sudo apt-get install python-docutils
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    49
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    50
Build docs:
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    51
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    52
.. code:: console
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    53
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    54
  $ make docs
47
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    55
57
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    56
Build jsdoc.
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    57
============
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    58
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    59
.. code:: console
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    60
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    61
  $ make jsdoc
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    62
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    63
Refer for JSDoc syntax to:
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    64
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    65
 * http://usejsdoc.org/
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    66
 * https://developers.google.com/closure/compiler/docs/js-for-compiler
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    67
 * https://code.google.com/p/jsdoc-toolkit/w/list
94e1b2d0bd31 Add JSDoc annotation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 47
diff changeset
    68
181
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    69
Deploy to hosting.
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    70
==================
77
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    71
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    72
Be sure you at Mercurial tagged revision and run:
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    73
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    74
.. code:: console
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    75
181
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    76
  $ make deploy
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    77
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    78
To deploy individually to ``defun.work`` or SourceForge run::
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    79
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    80
.. code:: console
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    81
2252379bcc70 Point to new home page.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 87
diff changeset
    82
  $ make deploy2defun
77
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    83
  $ make deploy2sf
c2bad6178c65 Add project docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 57
diff changeset
    84