2048-js-ai: HACKING.rst@c2bad6178c65 (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
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	13	Build docs.
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	14	===========
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	15
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	16	Install reStructuredText text processor - docutils. On Debian:
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	17
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	18	.. code:: console
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	19
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	20	$ sudo apt-get install python-docutils
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	21
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	22	Build docs:
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	23
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	24	.. code:: console
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	25
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	26	$ make docs
47 74b1f4d0f9a4 README Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	27
57 94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	28	Build jsdoc.
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	29	============
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	30
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	31	.. code:: console
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	32
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	33	$ make jsdoc
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	34
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	35	Refer for JSDoc syntax to:
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	36
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	37	* http://usejsdoc.org/
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	38	* https://developers.google.com/closure/compiler/docs/js-for-compiler
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	39	* https://code.google.com/p/jsdoc-toolkit/w/list
94e1b2d0bd31 Add JSDoc annotation. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 47 diff changeset	40
77 c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	41	Deploy to SourceForge.
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	Be sure you at Mercurial tagged revision and run:
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	$ make deploy2sf
c2bad6178c65 Add project docs. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 57 diff changeset	49

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--