Mercurial > molko

comparison INSTALL.md @ 13:c188e9603faf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: add basic documentation files
author David Demelier <markand@malikania.fr>
date Tue, 07 Jan 2020 21:34:03 +0100
parents
children 621c815c9509
comparison
equal deleted inserted replaced
12:29b479760c05 13:c188e9603faf
1 Molko's Adventure INSTALL
2 =========================
3
4 Installation instructions.
5
6 Requirements
7 ------------
8
9 - C99 compliant compiler,
10 - POSIX system (make, ar, shell),
11 - [SDL2][], Multimedia library,
12 - [SDL2_image][], Image loading addon for SDL2,
13 - [SDL2_ttf][], Fonts addon for SDL2,
14 - [SDL2_mixer][], Audio addon for SDL2.
15
16 Basic installation
17 ------------------
18
19 Quick install.
20
21 $ tar xvzf molko-x.y.z-tar.xz
22 $ cd molko-x.y.z
23 $ make
24 # sudo make install
25 $ molko
26
27 Platform: Windows
28 -----------------
29
30 On Windows, only [MSYS2][] is supported.
31
32 The code may compile on Microsoft Visual Studio but no support for it is
33 provided as it is not opensource and not standard compliant.
34
35 Once you have MSYS2 installed, simply install the following packages from the
36 appropriate MinGW shell prior to the chapter above.
37
38 - *make*
39 - *mingw-w64-x86_64-gcc*
40 - *mingw-w64-x86_64-SDL2*
41 - *mingw-w64-x86_64-SDL2_image*
42 - *mingw-w64-x86_64-SDL2_mixer*
43 - *mingw-w64-x86_64-SDL2_ttf*
44
45 Note: replace `x86_64` with `i686` if you have a deprecated system.
46
47 [SDL2]: http://libsdl.org
48 [SDL2_image]: https://www.libsdl.org/projects/SDL_image
49 [SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf
50 [SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer
51 [MSYS2]: http://www.msys2.org