summaryrefslogtreecommitdiff
path: root/doc/api.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api.texi')
-rw-r--r--doc/api.texi3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 56df86f..b22fd57 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -33,6 +33,9 @@ styles of game loops. The appropriately named @code{run-game} and
@code{abort-game} procedures are the entry and exit points to the
Chickadee game loop.
+If you are using @command{chickadee play} to launch your game, then
+calling @code{run-game} is already taken care of for you.
+
@deffn {Procedure} run-game [#:window-title "Chickadee!"] @
[#:window-width 640] [#:window-height 480] @
[#:window-fullscreen? @code{#f}] @