summaryrefslogtreecommitdiff
path: root/doc/chickadee.texi
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@vistahigherlearning.com>2017-01-18 15:21:54 -0500
committerDavid Thompson <dthompson@vistahigherlearning.com>2017-01-18 15:24:59 -0500
commitee2cc0b45f5dc8682f5e54cc36c165e1c6ad9f9b (patch)
treed9b458ca9b8801224b1ec5625759bc16e3194fdc /doc/chickadee.texi
parent320f8ab443a1a13b64ae38bee5bf55f111259c05 (diff)
doc: Add the beginnings of an API reference.
Diffstat (limited to 'doc/chickadee.texi')
-rw-r--r--doc/chickadee.texi12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/chickadee.texi b/doc/chickadee.texi
index 7e9362f..c662506 100644
--- a/doc/chickadee.texi
+++ b/doc/chickadee.texi
@@ -46,6 +46,7 @@ The document was typeset with
@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::
@@ -75,11 +76,20 @@ and is not covered here. Please see the files @file{README.org} and
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, 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