|
| From: | Neil Mitchell |
| Subject: | Pingus Readme |
| Date: | Tue, 6 Apr 2004 23:02:30 +0100 |
Hi, I was rooting around the SVN and noticed there are lots and lots of readme files, for different purposes, without particular clear meanings or up to date information. To combat this I think there needs to be one readme for users, and one for developers, and nothing else. I think the readme for users should also be in HTML format, instead of plain text. The reason for this is that a table of contents would be useful, and HTML does this a lot better. Also (minimal) styling would be nice, with proper topics. Also there are lots of links which would be clickable. Finally, all browsers support all line endings, however most text editors don't - so an HTML readme is if anything more viewable for more people. I have written (or gathered together) such a readme for the users, and would like feedback - is this a better direction than lots of small readmes? Is HTML the right choice? Does the readme have the right content areas in? A lot of the topics need filling in, and in most cases thats because there is no equivalent information in other readmes around the place. If this is the right direction, maybe checking it into SVN, and then anyone can submit patches (I have no idea about a lot of the stuff in there) This takes all the content from: AUTHORS COPYING INSTALL.unix README README.languages The files I have marked for inclusion in a developers readme are: INSTALL.unix INSTALL.Win32 MAINTAINING README.Win32 If this is a sensible idea, then I'll draft a basic developers readme as well and flesh out (or ask for information for) some of the topics in the user readme. Thanks Neil
Pingus is a free Lemmings(tm) clone for GNU/Linux, Win32 and other operating systems supported by ClanLib. It is covered under the GPLv2, see the license, for more information.
This section will describe how to compile Pingus. This is only needed if you run a non-x86 architecture or a non-Linux Unix like OS (FreeBSD, GNU/Hurd or something like that).
To compile Pingus you need:
For full music and sound support you also need:
Compile Hermes, MikMod, libxml2 and Voribs before ClanLib. To compile ClanLib you need to apply all the patches to it from the contrib/clanlib/ subdirectory to it, without them Pingus will have a few bugs (editor windows have a close button, which on click results in freeze or crash, console will be showable/hidable with many keys, scrollwheel support will be missing). Once all libraries are in place, compile Pingus with:
% ./configure % makeYou can now run Pingus directly from the src/ subdirectory. If you want to install Pingus, which is required if you want to have the i18n support working, just type:
% make installFor non-root installs use something like:
% ./configure --prefix=/home/juser % make % make installStarting Pingus can be done by:
% src/pingusIf you have a slow machine, starting Pingus with:
% src/pingus -g 640x480 --frame-skip 3Might lead to a better playable game. Fullscreen support is available via:
% src/pingus --fullscreen
In addition to the normal X11 support, Pingus can also be compiled with OpenGL support, to do so you just need to make sure that you have ClanGL compiled and installed (its part of ClanLib) and then compile Pingus with:
% ./configure --with-clanGL % makeYou need than to start Pingus with:
% src/pingus --use-openglBut note, that OpenGL support is buggy and lead to visual artifacts, OpenGL graphic cards with a texturesize of 1024x1024 or lower will also cause throuble and be unable to display the Worldmap.
| cs_CZ | Czech / | (ISO-8859-2) |
| de_DE | German / Deutsch | (ISO-8859-1) |
| en_US | English - default | (ISO-8859-1) |
| tr_TR | Turkish / Türkçe | (ISO-8859-9/ISO-8859-1) |
| it_IT | Italian / Italyano | (ISO-8859-1) |
| sv_SE | (ISO-8859-1) | |
| sr_SR | (ISO-8859-2) | |
If your environment is already set so that you are able to see (some) applications in the desired Language, Pingus should start directly in that language.
However, to start it directly with the language you want you should start Pingus as follows ...
LANG=tr_TR pingusThis sets the system variable 'LANG' to the value of 'tr_TR' (in this example).
The notation may be a bit confusing. The two lowercase letters are use to denote the language, usually the two letter ISO code of the country the language is spoken in.
After the underscore (_), the two uppercase letters denote the country. Again the two letter ISO country code is used.
some examples
If you want to help the translation effort, please look at the README.translate file in the ./po directory of the source code
Ingo Ruhnke address@hidden - http://pingus.seul.org/~grumbel/
Michael Käser address@hidden
Joel Fauche address@hidden - http://www.multimania.com/jfauche/
Michael Mestre address@hidden - http://www.teaser.fr/~mmestre/
Craig Timpany address@hidden
Jules Bean address@hidden
David Philippi address@hidden
Johnny Taporg address@hidden
Thomas Prokosch address@hidden
Robert Wittams address@hidden
Werner Steiner address@hidden
H. Matthew Smith address@hidden
Joseph Toscano address@hidden - http://zhaymusic.com/
Magnus Norddahl address@hidden - http://dark.x.dtu.dk/~mbn/
Stefan Stiasny address@hidden - http://sc.ist.org/
Alan Tennent address@hidden
Kenneth Gangstø address@hidden
Peter Todd address@hidden - http://www.petertodd.ca
David Fauthoux address@hidden - http://david.fauthoux.free.fr/
David M. Turner address@hidden
David Flores address@hidden
Tuomas (Tigert) Kuosmanen address@hidden - http://tigert.gimp.org/
Keir Fraser address@hidden
Felix Natter address@hidden
Mark Collinson address@hidden
Tom Flavel address@hidden
Michael Wand address@hidden
Jens Henrik Goebbert address@hidden
Bernhard Trummer address@hidden
Andrew Mustun address@hidden
Benjamin Winkler
Jens Henrik Goebbert address@hidden
Rob Gietema address@hidden
Robin Hogan address@hidden
Yuri Sucupira address@hidden
Giray Devlet address@hidden
Cagri Coltekin address@hidden
Philippe Descamps address@hidden
Gervase Lam address@hidden
Alberto Curro address@hidden
Mattias Andersson address@hidden
Fischer, Björn Christoph address@hidden
Neil Mitchell address@hidden
Giuseppe D'Aqui' address@hidden
Henri Manson address@hidden:
Milan Babuskov address@hidden
Philippe Saint-Pierre address@hidden
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
| [Prev in Thread] | Current Thread | [Next in Thread] |