Mercurial > pygame
annotate readme.rst @ 3172:d1b367fc08bc tests-returncode
Use a return code of 1 when the tests fail.
| author | Thomas Kluyver <takowl@gmail.com> |
|---|---|
| date | Wed, 09 Jan 2013 10:13:57 +0000 |
| parents | 11f04fded9a8 |
| children |
| rev | line source |
|---|---|
| 732 | 1 |
| 2 | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
3 About pygame |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
4 ============ |
| 732 | 5 |
| 6 Pygame is a cross-platfrom library designed to make it easy to | |
| 7 write multimedia software, such as games, in Python. Pygame | |
| 8 requires the Python language and SDL multimedia library. It can | |
| 9 also make use of several other popular libraries. | |
| 10 | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
11 http://www.pygame.org |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
12 |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
13 |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
14 Installation |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
15 ============ |
| 732 | 16 |
| 17 You should definitely begin by installing a binary package for your | |
| 18 system. The binary packages usually come with or give the | |
| 19 information needed for dependencies. Choose an appropriate | |
| 20 installer for your system and version of python from the pygame | |
| 21 downloads page. http://www.pygame.org/download.shtml | |
| 22 | |
| 23 Installing from source is fairly automated. The most work will | |
| 24 involve compiling and installing all the pygame dependencies. Once | |
| 25 that is done run the "setup.py" script which will attempt to | |
| 26 auto-configure, build, and install pygame. | |
| 27 | |
| 28 Much more information about installing and compiling is available | |
| 29 in the install.html file. | |
| 30 | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
31 Help |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
32 ==== |
| 732 | 33 |
| 34 If you are just getting started with pygame, you should be able to | |
| 35 get started fairly quickly. Pygame comes with many tutorials and | |
| 36 introductions. There is also full reference documentation for the | |
| 37 entire library. Browse the documentation from the documenantation | |
| 38 index. docs/index.html. | |
| 39 | |
| 40 On the pygame website, there is also an online copy of this | |
| 41 documentation. You should know that the online documentation stays | |
|
3164
11f04fded9a8
A couple of small updates to the readme.rst
Rene Dudfield <renesd@gmail.com>
parents:
3027
diff
changeset
|
42 up to date with the development version of pygame in hg. This may |
| 732 | 43 be a bit newer than the version of pygame you are using. |
| 44 | |
| 45 Best of all the examples directory has many playable small programs | |
| 46 which can get started playing with the code right away. | |
| 47 | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
48 Credits |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
49 ======= |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
50 |
| 732 | 51 |
| 52 Thanks to everyone who has helped contribute to this library. | |
| 53 Special thanks are also in order. | |
| 54 | |
|
970
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
55 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
56 Marcus Von Appen - many changes, and fixes, 1.7.1+ freebsd maintainer. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
57 |
|
1887
c75882a366f6
updated some credits in the readmes.
Rene Dudfield <renesd@gmail.com>
parents:
1883
diff
changeset
|
58 Lenard Lindstrom - the 1.8+ windows maintainer, many changes, and fixes. |
|
970
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
59 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
60 Brian Fisher - for svn auto builder, bug tracker and many contributions. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
61 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
62 Rene Dudfield - many changes, and fixes, 1.7+ release manager/maintainer. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
63 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
64 Phil Hassey - for his work on the pygame.org website. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
65 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
66 DR0ID for his work on the sprite module. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
67 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
68 Richard Goedeken for his smoothscale function. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
69 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
70 Ulf Ekström for his pixel perfect collision detection code. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
71 |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
72 Pete Shinners - orginal author. |
|
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
73 |
| 732 | 74 David Clark - for filling the right-hand-man position |
| 75 | |
| 76 Ed Boraas and Francis Irving - Debian packages | |
| 77 | |
| 78 Maxim Sobolev - FreeBSD packaging | |
| 79 | |
| 80 Bob Ippolito - MacOS and OS X porting (much work!) | |
| 81 | |
| 82 Jan Ekhol, Ray Kelm, and Peter Nicolai - putting up with my early | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
83 design ideas |
| 732 | 84 |
| 85 Nat Pryce for starting our unit tests | |
| 86 | |
| 87 Dan Richter for documentation work | |
| 88 | |
| 89 TheCorruptor for his incredible logos and graphics | |
| 90 | |
| 1223 | 91 Nicholas Dudfield - many test improvements. |
| 92 | |
| 93 Alex Folkner - for pygame-ctypes | |
| 94 | |
| 732 | 95 Thanks to those sending in patches and fixes: Niki Spahiev, Gordon |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
96 Tyler, Nathaniel Pryce, Dave Wallace, John Popplewell, Michael Urman, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
97 Andrew Straw, Michael Hudson, Ole Martin Bjoerndalen, Hervé Cauwelier, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
98 James Mazer, Lalo Martins, Timothy Stranex, Chad Lester, Matthias |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
99 Spiller, Bo Jangeborg, Dmitry Borisov, Campbell Barton, Diego Essaya, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
100 Eyal Lotem, Regis Desgroppes, Emmanuel Hainry, Randy Kaelber |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
101 Matthew L Daniel, Nirav Patel, Forrest Voight, Charlie Nolan, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
102 Frankie Robertson, John Krukoff, Lorenz Quack, Nick Irvine, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
103 Michael George, Saul Spatz, Thomas Ibbotson, Tom Rothamel, Evan Kroske, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
104 Cambell Barton. |
| 732 | 105 |
| 106 And our bug hunters above and beyond: Angus, Guillaume Proux, Frank | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
107 Raiser, Austin Henry, Kaweh Kazemi, Arturo Aldama, Mike Mulcheck, |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
108 Michael Benfield, David Lau |
| 732 | 109 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
110 There's many more folks out there who've submitted helpful ideas, kept |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
111 this project going, and basically made my life easer, Thanks! |
| 732 | 112 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
113 Many thank you's for people making documentation comments, and adding to the |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
114 pygame.org wiki. |
|
970
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
115 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
116 Also many thanks for people creating games and putting them on the |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
117 pygame.org website for others to learn from and enjoy. |
|
970
75e22b1cd487
Added missing credits to readme.
Rene Dudfield <renesd@gmail.com>
parents:
942
diff
changeset
|
118 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
119 Lots of thanks to James Paige for hosting the pygame bugzilla. |
|
1887
c75882a366f6
updated some credits in the readmes.
Rene Dudfield <renesd@gmail.com>
parents:
1883
diff
changeset
|
120 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
121 Also a big thanks to Roger Dingledine and the crew at SEUL.ORG for our |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
122 excellent hosting. |
| 732 | 123 |
|
1887
c75882a366f6
updated some credits in the readmes.
Rene Dudfield <renesd@gmail.com>
parents:
1883
diff
changeset
|
124 |
|
c75882a366f6
updated some credits in the readmes.
Rene Dudfield <renesd@gmail.com>
parents:
1883
diff
changeset
|
125 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
126 Dependencies |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
127 ============ |
| 732 | 128 |
| 129 Pygame is obviously strongly dependent on SDL and Python. It also | |
| 130 links to and embeds several other smaller libraries. The font | |
| 131 module relies on SDL_tff, which is dependent on freetype. The mixer | |
| 132 (and mixer.music) modules depend on SDL_mixer. The image module | |
| 133 depends on SDL_image, which also can use libjpeg and libpng. The | |
| 134 transform module has an embedded version of SDL_rotozoom for its | |
| 135 own rotozoom function. The surfarray module requires the python | |
| 136 Numeric package for its multidimensional numeric arrays. | |
| 137 | |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
138 Todo / Ideas (feel free to submit) |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
139 ================================== |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
140 |
| 1883 | 141 http://www.pygame.org/wiki/todo/ |
| 732 | 142 |
|
3027
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
143 License |
|
9c88c478be0d
Moving the readme.txt into readme.rst which generates the html version.
Rene Dudfield <renesd@gmail.com>
parents:
1926
diff
changeset
|
144 ======= |
| 732 | 145 |
| 146 This library is distributed under GNU LGPL version 2.1, which can | |
| 147 be found in the file "doc/LGPL". I reserve the right to place | |
| 148 future versions of this library under a different license. | |
| 149 http://www.gnu.org/copyleft/lesser.html | |
| 150 | |
| 151 This basically means you can use pygame in any project you want, | |
| 152 but if you make any changes or additions to pygame itself, those | |
| 153 must be released with a compatible license. (preferably submitted | |
| 154 back to the pygame project). Closed source and commercial games are | |
| 155 fine. | |
| 156 | |
| 157 The programs in the "examples" subdirectory are in the public | |
| 158 domain. |
