docs: Add explanation about IsRunningSlowly

Fixes hajimehoshi#508
ablegao · Apr 1, 2018 · 861c737 · 861c737
1 parent 75ac8e6
commit 861c737
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/doc.go b/doc.go
@@ -16,11 +16,24 @@
 //
 // You can start the game by calling the function Run.
 //
+//     // update is called every frame (1/60 [s]).
 //     func update(screen *ebiten.Image) error {
-//         // Define your game.
+//
+//         // Write your game's logical update.
+//
+//         if IsRunningSlowly() {
+//             // When the game is running slowly, the rendering result
+//             // will not be adopted.
+//             return nil
+//         }
+//
+//         // Write your game's rendering.
+//
+//         return nil
 //     }
 //
 //     func main() {
+//         // Call ebiten.Run to start your game loop.
 //         ebiten.Run(update, 320, 240, 2, "Your game's title")
 //     }
 package ebiten