Changeset - r20210:472036b325a2
[Not reviewed]
master
0 2 0
planetmaker - 11 years ago 2013-04-26 18:39:15
planetmaker@openttd.org
(svn r25209) -Doc: Mention --without-grfcodec in the help for configure and explain its use in the readme
2 files changed with 18 insertions and 7 deletions:
0 comments (0 inline, 0 general)
config.lib
Show inline comments
 
@@ -3635,24 +3635,25 @@ showhelp() {
 
	echo "                                 enables libfreetype support"
 
	echo "  --with-fontconfig[=pkg-config fontconfig]"
 
	echo "                                 enables fontconfig support"
 
	echo "  --with-icu[=icu-config]        enables icu (used for right-to-left support)"
 
	echo "  --static-icu                   try to link statically (libsicu instead of"
 
	echo "                                 libicu; can fail as the new name is guessed)"
 
	echo "  --with-iconv[=iconv-path]      enables iconv support"
 
	echo "  --with-psp-config[=psp-config] enables psp-config support (PSP ONLY)"
 
	echo "  --disable-builtin-depend       disable use of builtin deps finder"
 
	echo "  --with-makedepend[=makedepend] enables makedepend support"
 
	echo "  --with-ccache                  enables ccache support"
 
	echo "  --with-distcc                  enables distcc support"
 
	echo "  --without-grfcodec             disable usage of grfcodec and re-generation of base sets"
 
	echo ""
 
	echo "Some influential environment variables:"
 
	echo "  CC                             C compiler command"
 
	echo "  CXX                            C++ compiler command"
 
	echo "  CFLAGS                         C compiler flags"
 
	echo "  CXXFLAGS                       C++ compiler flags"
 
	echo "  WINDRES                        windres command"
 
	echo "  LDFLAGS                        linker flags, e.g. -L<lib dir> if you"
 
	echo "                                 have libraries in a nonstandard"
 
	echo "                                 directory <lib dir>"
 
	echo "  CFLAGS_BUILD                   C compiler flags for build time tool generation"
 
	echo "  CXXFLAGS_BUILD                 C++ compiler flags for build time tool generation"
readme.txt
Show inline comments
 
OpenTTD readme
 
Last updated:    2013-04-01
 
Last updated:    2013-04-26
 
Release version: 1.3.0
 
------------------------------------------------------------------------
 

	
 

	
 
Table of contents
 
-----------------
 
1.0) About
 
2.0) Contacting
 
 * 2.1) Reporting bugs
 
 * 2.2) Reporting desyncs
 
3.0) Supported platforms
 
4.0) Installing and running OpenTTD
 
 * 4.1) (Required) 3rd party files
 
 * 4.2) OpenTTD directories
 
 * 4.3) Portable installations (portable media)
 
 * 4.4) Files in tar (archives)
 
5.0) OpenTTD features
 
 * 5.1) Logging of potentially dangerous actions
 
6.0) Configuration file
 
7.0) Compiling
 
 * 7.1) Required/optional libraries
 
 * 7.2) Supported compilers
 
 * 7.3) Compilation of base sets
 
8.0) Translating
 
 * 8.1) Translation
 
 * 8.2) Previewing
 
9.0) Troubleshooting
 
X.X) Credits
 

	
 

	
 
1.0) About
 
---- -----
 
OpenTTD is a transport simulation game based upon the popular game Transport
 
Tycoon Deluxe, written by Chris Sawyer. It attempts to mimic the original
 
game as closely as possible while extending it with new features.
 
@@ -492,30 +493,24 @@ The following libraries are used by Open
 
  - 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 - 4.6 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.
 
  - Clang/LLVM 2.9 - 3.0
 
    Version 2.9 gives bogus warnings about code nonconformity.
 
@@ -526,24 +521,39 @@ The following compilers are known not to
 
    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 an 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.
 

	
 
7.3) Compilation of base sets
 
-----------------------------
 
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'.
 

	
 
Re-compilation of the base sets, thus also use of --maintainer-clean can
 
leave the repository in a modified state as different grfcodec versions can
 
cause binary differences in the resulting grf. Also translations might have
 
been added for the base sets which are not yet included in the base set
 
information files. Use the configure option --without-grfcodec to avoid
 
modification of the base set files by the build process.
 

	
 

	
 
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.
 

	
0 comments (0 inline, 0 general)