diff lib/examples.doc @ 1617:324c19f22af0

Add pygame.examples.go shortcut
author Lenard Lindstrom <len-l@telus.net>
date Wed, 13 May 2009 20:04:38 +0000
parents 05354a46bd12
children 154b030df6e5
line wrap: on
line diff
--- a/lib/examples.doc	Wed May 13 04:56:18 2009 +0000
+++ b/lib/examples.doc	Wed May 13 20:04:38 2009 +0000
@@ -5,8 +5,16 @@
 brief rundown of what you get. The source code for these examples
 is in the public domain. Feel free to use for your own projects.
 
-These examples can be run as stand-alone programs, or as described
-below, by importing the module and calling its main().
+There are several ways to run the examples. First they can be run
+as stand-alone programs. Second they can be imported and their
+main() methods called (see below). Finally, the prefered way is
+with the pygame.examples.go module:
+
+python -c "import pygame.examples.go" <example name> <example arguments>
+
+To list available examples:
+
+python -c "import pygame.examples.go" --list
 
 Resources for the examples are found in the pygame/examples/data
 subdirectory.