2048-js-ai: HACKING.rst@8715659bcce6 (annotated)

77 c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	1	.. include:: header.rst
47 74b1f4d0f9a4 README Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	2
74b1f4d0f9a4 README Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	3	==================
74b1f4d0f9a4 README Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	4	2048 game JS AI.
74b1f4d0f9a4 README 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
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	19	http://js-2048-ai.sourceforge.net/
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	20	Home page.
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	21	https://sourceforge.net/p/js-2048-ai/
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	22	SF home page.
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	23	https://sourceforge.net/projects/js-2048-ai/files/
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	24	Releases.
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	25
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	26	Getting sources.
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
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	29	.. code:: console
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	$ 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	32
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	33	Getting help.
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	34	=============
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	See Authors_.
3fa365b14c66 Getting sources. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 77 diff changeset	37
77 c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	38	Build docs.
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	39	===========
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	40
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	41	Install reStructuredText text processor - docutils. On Debian:
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	.. code:: console
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	44
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	45	$ sudo apt-get install python-docutils
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	46
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	47	Build docs:
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	48
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	49	.. code:: console
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	50
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	51	$ make docs
47 74b1f4d0f9a4 README Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	52
57 94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	53	Build jsdoc.
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	54	============
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	55
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	56	.. code:: console
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	$ make jsdoc
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	59
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	60	Refer for JSDoc syntax to:
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	61
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	62	* http://usejsdoc.org/
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	63	* https://developers.google.com/closure/compiler/docs/js-for-compiler
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	64	* https://code.google.com/p/jsdoc-toolkit/w/list
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	65
77 c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	66	Deploy to SourceForge.
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	67	======================
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	68
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	69	Be sure you at Mercurial tagged revision and run:
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	70
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	71	.. code:: console
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	72
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	73	$ make deploy2sf
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	74

author	Oleksandr Gavenko <gavenkoa@gmail.com>
	Wed, 24 Sep 2014 22:26:41 +0300
changeset 132	8715659bcce6
parent 87	3fa365b14c66
child 181	2252379bcc70
permissions	-rw-r--r--