webperimental: killstack decides stack protects.
[freeciv.git] / doc / INSTALL.Cygwin
blob4572e6be502762bcf14235126757bcdf1a2f5d39
2 Cygwin installation notes
3 =========================
5 This is doc/INSTALL-Cygwin, which contains specific Freeciv installation
6 information for the Cygwin platform.
8 A translated version of this file may be in language specific
9 subdirectories of doc/.
11 See also the generic installation notes in INSTALL.
13 Cygwin is a free Unix variant for MS Windows operating systems.
14 Recent versions come with an X server, Xorg.
16 To install Freeciv for Cygwin:
18 a) Install or update your Cygwin using the "Install Cygwin Now!" link
19    on http://www.cygwin.com/;
21    In addition to default install, install at least following packages
22    to build freeciv
23    (packages to be installed as dependency of another one in the list
24      are not listed):
25    - gcc-g++ (section Development)
26    - pkg-config (Development)
27    - make (Development)
28    - libiconv-devel (Libs)
29    - libcurl-devel (Libs)
30    - zlib-devel (Libs)
32   Install development package for the gui you want to compile, one of
33   - libgtk3-devel (Libs)
35   For additional functionality install also:
36    - libreadline-devel (Libs)
37    - gettext-devel (Development)
39   To get and build freeciv development version directly from version control,
40   you need also
41    - subversion (Development)
42    - automake1.14 (Development)
43    - libtool (Development)
45   To run freeciv client, you need to install also
46   - xlaunch (X11)
47   - fontconfig (X11)
49 b) Get a Freeciv source tree (the doc/ subdirectory this file is in, is in source
50    tree's top directory).
51    Put it in a temporary place like /tmp.
53       ./configure --enable-client=<gui> [any other options e.g. --prefix=...]
54    where <gui> is "gtk3". If you
55    didn't install gettext-devel, you have to give also configure option
56    --disable-nls to disable Native Language Support.
58    If you are building directly from version control, and not from
59    tarball that has some files, including ./configure, pregenerated,
60    you need to run ./autogen.sh instead of ./configure. Use same options
61    as you would for directly running ./configure.
63    If you get messages of missing or outdated components, install them.
65 c) Compile and install Freeciv:
67       make
68       make install
70 You should now have bin/freeciv-server.exe and bin/freeciv-<gui>.exe in the
71 directory you installed Freeciv into (/usr/local by default).
72 If 'make install' succeeds, the source code tree can be removed.
74 d) Test the results:
76     /path/to/freeciv-server.exe  [any additional options]
78   will start the server, but you only need it for private games.
79   To start the client, you need to run the X server (this can be
80   done by typing 'xlaunch'), then into a terminal type
82     /path/to/freeciv-<gui>.exe  [any additional options]
84 More details on using server and client are in doc/README.