diff INSTALL.md @ 13:c188e9603faf

misc: add basic documentation files
author David Demelier <markand@malikania.fr>
date Tue, 07 Jan 2020 21:34:03 +0100
parents
children 621c815c9509
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.md	Tue Jan 07 21:34:03 2020 +0100
@@ -0,0 +1,51 @@
+Molko's Adventure INSTALL
+=========================
+
+Installation instructions.
+
+Requirements
+------------
+
+- C99 compliant compiler,
+- POSIX system (make, ar, shell),
+- [SDL2][], Multimedia library,
+- [SDL2_image][], Image loading addon for SDL2,
+- [SDL2_ttf][], Fonts addon for SDL2,
+- [SDL2_mixer][], Audio addon for SDL2.
+
+Basic installation
+------------------
+
+Quick install.
+
+	$ tar xvzf molko-x.y.z-tar.xz
+	$ cd molko-x.y.z
+	$ make
+	# sudo make install
+	$ molko
+
+Platform: Windows
+-----------------
+
+On Windows, only [MSYS2][] is supported.
+
+The code may compile on Microsoft Visual Studio but no support for it is
+provided as it is not opensource and not standard compliant.
+
+Once you have MSYS2 installed, simply install the following packages from the
+appropriate MinGW shell prior to the chapter above.
+
+- *make*
+- *mingw-w64-x86_64-gcc*
+- *mingw-w64-x86_64-SDL2*
+- *mingw-w64-x86_64-SDL2_image*
+- *mingw-w64-x86_64-SDL2_mixer*
+- *mingw-w64-x86_64-SDL2_ttf*
+
+Note: replace `x86_64` with `i686` if you have a deprecated system.
+
+[SDL2]: http://libsdl.org
+[SDL2_image]: https://www.libsdl.org/projects/SDL_image
+[SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf
+[SDL2_mixer]: https://www.libsdl.org/projects/SDL_mixer
+[MSYS2]: http://www.msys2.org