File diff r17802:1bedd49d5829 → r17803:d18efcf337ff
readme.txt
Show inline comments
 
@@ -426,96 +426,97 @@ MorphOS:
 
OS/2:
 
  A comprehensive GNU build environment is required to build the OS/2 version.
 
  See the docs/Readme_OS2.txt file for more information.
 

	
 
DOS:
 
  A build environment with DJGPP is needed as well as libraries such as
 
  Allegro, zlib and libpng, which all can be downloaded from the DJGPP
 
  website. Compilation is straight forward: use make, but do a "./configure"
 
  before the first build. The build binary will need cwsdpmi.exe to be in
 
  the same directory as the openttd executable. cwsdpmi.exe can be found in
 
  the os/dos subdirectory. If you compile with stripping turned on a binary
 
  will be generated that does not need cwsdpmi.exe by adding the cswdstub.exe
 
  to the created OpenTTD binary.
 

	
 
7.1) Required/optional libraries
 
---- ---------------------------
 
The following libraries are used by OpenTTD for:
 
  - libSDL/liballegro: hardware access (video, sound, mouse)
 
  - zlib: (de)compressing of old (0.3.0-1.0.5) savegames, content downloads,
 
    heightmaps
 
  - liblzo2: (de)compressing of old (pre 0.3.0) savegames
 
  - liblzma: (de)compressing of savegames (1.1.0 and later)
 
  - libpng: making screenshots and loading heightmaps
 
  - libfreetype: loading generic fonts and rendering them
 
  - libfontconfig: searching for fonts, resolving font names to actual fonts
 
  - libicu: handling of right-to-left scripts (e.g. Arabic and Persian) and
 
    natural sorting of strings.
 

	
 
OpenTTD does not require any of the libraries to be present, but without
 
liblzma you cannot open most recent savegames and without zlib you cannot
 
open most older savegames or use the content downloading system.
 
Without libSDL/liballegro on non-Windows and non-MacOS X machines you have
 
no graphical user interface; you would be building a dedicated server.
 

	
 
To recompile the extra graphics needed to play with the original Transport
 
Tycoon Deluxe graphics you need GRFCodec (which includes NFORenum) as well.
 
GRFCodec can be found at: http://www.openttd.org/download-grfcodec
 
The compilation of these extra graphics does generally not happen, unless
 
you remove the graphics file using "make maintainer-clean".
 

	
 
7.2) Supported compilers
 
---- -------------------
 
The following compilers are known to compile OpenTTD:
 
  - Microsoft Visual C++ (MSVC) 2005, 2008 and 2010.
 
    Version 2005 gives bogus warnings about scoping issues.
 
  - GNU Compiler Collection (GCC) 3.3 - 4.7.
 
    Versions 4.1 and earlier give bogus warnings about uninitialised variables.
 
    Versions 4.4 and later give bogus warnings about freeing non-heap objects.
 
    Versions 4.5 and later give invalid warnings when lto is enabled.
 
  - Intel C++ Compiler (ICC) 12.0.
 

	
 
The following compilers are known not to compile OpenTTD:
 
  - Microsoft Visual C++ (MSVC) 2003 and earlier.
 
  - GNU Compiler Collection (GCC) 3.2 and earlier.
 
    These old versions fail due to OpenTTD's template usage.
 
  - Intel C++ Compiler (ICC) 11.1 and earlier.
 
    Version 10.0 and earlier fail a configure check and fail with recent system
 
        headers.
 
    Version 10.1 fails to compile station_gui.cpp.
 
    Version 11.1 fails with internal error when compiling network.cpp.
 
  - Clang/LLVM 2.8 and earlier.
 
  - (Open) Watcom.
 

	
 
If any of these compilers can compile OpenTTD again, please let us know.
 
Patches to support more compilers are welcome.
 

	
 

	
 
8.0) Translating
 
---- -----------
 
See http://www.openttd.org/development for up-to-date information.
 

	
 
The use of the online Translator service, located at
 
http://translator.openttd.org/, is highly encouraged. For getting an account
 
simply follow the guidelines in the FAQ of the translator website.
 

	
 
If for some reason the website is down for a longer period of time, the
 
information below might be of help.
 

	
 
Please contact the translations manager (http://www.openttd.org/contact)
 
before beginning the translation process! This avoids double work, as
 
someone else may have already started translating to the same language.
 

	
 
8.1) Translation
 
---- -----------
 
So, now that you've notified the development team about your intention to
 
translate (You did, right? Of course you did.) you can pick up english.txt
 
(found in the SVN repository under /src/lang) and translate.
 

	
 
You must change the first two lines of the file appropriately:
 

	
 
##name English-Name-Of-Language
 
##ownname Native-Name-Of-Language
 

	
 
Note: Do not alter the following parts of the file:
 

	
 
    * String identifiers (the first word on each line)
 
    * Parts of the strings which are in curly braces (such as {STRING})