From ee2cc0b45f5dc8682f5e54cc36c165e1c6ad9f9b Mon Sep 17 00:00:00 2001 From: David Thompson Date: Wed, 18 Jan 2017 15:21:54 -0500 Subject: doc: Add the beginnings of an API reference. --- doc/chickadee.texi | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'doc/chickadee.texi') 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 -- cgit v1.2.3