diff options
author | David Thompson <dthompson2@worcester.edu> | 2017-01-04 22:16:26 -0500 |
---|---|---|
committer | David Thompson <dthompson2@worcester.edu> | 2017-01-04 22:16:26 -0500 |
commit | 98dc87a054c1108bd5f4bb093024d962ce0c8ce2 (patch) | |
tree | 9fa25dca82134bcdbe8693bfd5b212ce3b3880f8 /doc/chickadee.texi |
First commit!
Diffstat (limited to 'doc/chickadee.texi')
-rw-r--r-- | doc/chickadee.texi | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/chickadee.texi b/doc/chickadee.texi new file mode 100644 index 0000000..7e9362f --- /dev/null +++ b/doc/chickadee.texi @@ -0,0 +1,104 @@ +\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. + +* 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.org} and +@file{INSTALL.org} 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.0.11 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 + +@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 |