1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename chickadee.info
@settitle The Chickadee Game Toolkit
@c %**end of header
@copying
Copyright @copyright{} 2016 David Thompson @email{davet@@gnu.org}
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
@end quotation
The document was typeset with
@uref{http://www.texinfo.org/, GNU Texinfo}.
@end copying
@titlepage
@title Chickadee 0.1
@subtitle Using the Chickadee game toolkit
@author David Thompson
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@c Output the table of the contents at the beginning.
@contents
@ifnottex
@node Top
@top Chickadee
@insertcopying
@end ifnottex
@c Generate the nodes for this menu with `C-c C-u C-m'.
@menu
* Installation:: Installing Chickadee.
* API Reference:: Chickadee API reference.
* Copying This Manual:: The GNU Free Documentation License and you!
* Index::
@end menu
@c Update all node entries with `C-c C-u C-n'.
@c Insert new nodes with `C-c C-c n'.
@node Installation
@chapter Installation
Chickadee is available for download from its website at
@url{dthompson.us/projects/chickadee.html}. This section describes
the software requirements of Chickadee, as well as how to install it.
The build procedure for Chickadee is the same as for GNU software
packages, and is not covered here. Please see the files @file{README}
and @file{INSTALL} for additional details.
@menu
* Requirements:: Software needed to build and run Chickadee.
@end menu
@node Requirements
@section Requirements
Chickadee depends on the following packages:
@itemize
@item @url{https://gnu.org/software/guile, GNU Guile}, version 2.1.0 or later;
@item @url{https://gnu.org/software/guile-opengl, GNU guile-opengl}, version 0.1 or later.
@item @url{https://dthompson.us/pages/software/guile-sdl2.html, guile-sdl2}, version 0.2.0 or later;
@end itemize
Additionally, Chickadee depends on being able to create an OpenGL 3.3
context at runtime, which means that some older computers may not be
able to run games written with Chickadee.
@node API Reference
@chapter API Reference
@include api.texi
@node Copying This Manual
@appendix Copying This Manual
@menu
* GNU Free Documentation License:: License for copying this manual.
@end menu
@c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
@node GNU Free Documentation License
@section GNU Free Documentation License
@include fdl.texi
@node Index
@unnumbered Index
@syncodeindex tp fn
@syncodeindex vr fn
@printindex fn
@bye
@c chickadee.texi ends here
|
