1How to install typespeed 0.6.5
2------------------------------
3Short answer: Type in "./configure && make all install" (without "").
4
5Index:
61   Requirements
71.1 Supported Plattforms
81.2 Supported Operating Systems
91.3 Needed Software
102   Installing Typespeed
112.1 Makefile Options
123   File Structure
13
141 Requirements
15--------------
16
17In order to compile typespeed, your system must fulfill the following
18requirements.
19
201.1 Supported Plattforms
21------------------------
22
23On the following plattforms, typespeed is known to work with at least
24one operating system listed in 1.2:
25
26- i386
27- mipsel
28- x86_64
29
301.2 Supported Operating Systems
31-------------------------------
32
33The following operating systems have been tested with typespeed.
34Due to limited resources, not every release can be tested with every
35operating system version.
36
37- Cygwin
38- FreeBSD
39- GNU/Linux (various distributions)
40- Mac OS X
41- OpenBSD
42- Windows
43
441.3 Needed Software
45-------------------
46
47You need a working toolchain for c programs (i.e. c compiler and
48linker). Development and tests are done with gcc and binutils.
49Other compilers might work, too.
50
51Please use GNU make in order to build typespeed. Issues are known with
52other make implementations.
53
54Next to this your system must provide common header files.  If you use
55a linux distribution, these could be supplied with packages ending in
56-dev (e.g. libc-dev).
57
58The last requirement is a curses library with corresponding header
59files.  Most systems are shipped with different curses implementations.
60
61To give an overview, these packages are used for development
62(GNU/Linux system running on x86_64):
63
64name          | minimum version known to work | used version
65--------------+-------------------------------+--------------
66autoconf      | 2.59                          | 2.62
67automake      | 1.9                           | 1.10.1
68binutils      | 2.7                           | 2.17
69gcc           | 2.95.2                        | 4.2.1
70glibc         | 2.2.2                         | 2.7
71make (GNU)    | 3.79.1                        | 3.81
72ncurses       | 4.0                           | 5.6
73
742 Installing Typespeed
75----------------------
76
77Please note that your system should have a group called "games".
78
79If you do not want to change any default settings, simply type in the
80following commands in top directory (do not type #):
81
82# ./configure && make all install
83
843 File Structure
85----------------
86
87If you have installed typespeed without supplying configure options, the
88following files and directories will be created:
89
90/usr/local/bin/typespeed
91/usr/local/etc/typespeedrc
92/usr/local/share/doc/typespeed/README
93/usr/local/share/man/man6/typespeed.6
94/usr/local/share/typespeed/rules/ (contains game rules)
95/usr/local/share/typespeed/words/ (contains word lists)
96/usr/local/var/games/typespeed.score
97
98Additionaly, if your system supports i18n, the following files will be
99installed which contain menu translations:
100
101/usr/local/share/locale/de_DE/LC_MESSAGES/typespeed.mo
102/usr/local/share/locale/fr_FR/LC_MESSAGES/typespeed.mo
103/usr/local/share/locale/it/LC_MESSAGES/typespeed.mo
104
105