Spanish Town Names
-----------------------------------

Version: Spanish Town Names 0.1.0

Contents:

1 About
2 Quickstart
3 Build requirements
4 Building from source
5 License
6 Credits



-------
1 About
-------

A NewGRF which includes all Spanish town names for OpenTTD.

Name of this Repo:  Spanish Town Names 0.1.0
Repository version: 9
GRF_ID:             "SPT" 01
MD5 sum:            a89d941564f75ae47173213d2422bcca  spanish_town_names.grf



--------------
2 Quickstart
--------------

Copy the grf file in your data dir and activate it in OpenTTD. You can also
use 'make install' (see section 4).



--------------------
3 Build requirements
--------------------

Requirements for building this NewGRF successfully:
	NML
	gcc
	md5sum (or md5 on Mac)
	make
	mercurial (recommended)
	python (recommended)

If you want to bundle the grf, you'll need additionally:
	tar
	zip
	bzip2
	unix2dos (optional)

Windows only:
On Windows systems this means that you'll need to install MinGW and MSYS
in order to obtain a POSIX compatible environment. Then the makefile can
be called the very same way as it is on Linux and Mac systems.

MinGW/MSYS contain the above mentioned programmes and can be obtained
from http://www.mingw.org/ That site also features an excellent
walk-through on how to install it.

If you use a non-default path for OpenTTD data folder or Windows with a
non-English localization make sure to copy Makefile.local.sample to
Makefile.local and edit the line with
	INSTALLDIR =
accordingly so that it shows the full path to your OpenTTD / TTDP data
directory.



----------------------
4 Building from source
----------------------

The Makefile offers different targets. A brief overview is given here:

all:
	This is the default target, if also no parameter is given to
	make. It will simply build the grf file, if it needs building.

depend:
	Re-run the dependency check. Usually not manually needed.

docs:
	Build the documentation files.

bundle:
	This target will create a directory called "<name>-nightly" and
	copy the grf file there and the documentation files, readme.txt,
	changelog.txt and license.txt.

bundle_zip
	This will zip the bundle directory into one zip for distribution.

bundle_tar
	This will tar the bundle directory into a tar archive for
	distribution or upload to bananas.

bundle_src
	Creates a source bundle.

install:
	This will create a tar archive (like bundle_tar) and copy it
	into the INSTALLDIR as specified in Makefile.local (or the
	default dir, if that isn't defined). Don't rely on a good
	detection of the default installation directory. It's
	especially bound to fail on windows machines.

distclean:
	This phony target cleans everything from a source bundle which
	wasn't shipped.

clean:
	This phony target will delete all files which this Makefile will
	create.

mrproper:
	This phony target will delete also all directories created by
	different Makefile targets.

remake:
	It's a shortcut for first cleaning the dir and then making the
	grf anew.

addcheck:
	Check whether there are some files required but not part of the
	repository.

check:
	Check the md5sum of the built newgrf against the supplied md5sum
	(Intended to be used when building from tar balls).



---------
5 License
---------

This NewGRF was written by José Ángel Soler Ortiz (aka Terkhen) and is free to
use for anyone under the terms of the GNU Public License v2 or higher. See
license.txt.

The source code can be obtained from the #openttdcoop DevZone at
http://dev.openttdcoop.org/projects/spanishtowns or via mercurial
checkout:
hg clone http://hg.openttdcoop.org/spanishtowns



---------
6 Credits
---------

Author: Terkhen

The town data has been obtained from the National Statistics Institute (INE).

Special thanks to planetmaker and Ammler for their advice and support, and to 
Hirundo, Yexo and Alberth for converting the NML project into a reality.