Mercurial > molko

comparison INSTALL.md @ 366:19782ea1cf4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: start rebranding
author David Demelier <markand@malikania.fr>
date Sun, 24 Oct 2021 15:57:42 +0200
parents 06782f7888f3
children 7ac4b10eedbe
comparison
equal deleted inserted replaced
365:06badab52877 366:19782ea1cf4a
1 Molko's Adventure INSTALL 1 Molko's Engine INSTALL
2 ========================= 2 ======================
3 3
4 Installation instructions. 4 Installation instructions.
5 5
6 Requirements 6 Requirements
7 ------------ 7 ------------
8 8
9 - C11 compliant compiler. 9 - C99 compliant compiler.
10 - [CMake][], CMake build system. 10 - [CMake][], CMake build system.
11 - [Jansson][], JSON parsing library. 11 - [Jansson][], JSON parsing library.
12 - [SDL2][], Multimedia library. 12 - [SDL2][], Multimedia library.
13 - [SDL2_image][], Image loading addon for SDL2. 13 - [SDL2_image][], Image loading addon for SDL2.
14 - [SDL2_mixer][], Audio addon for SDL2. 14 - [SDL2_mixer][], Audio addon for SDL2.
15 - [SDL2_ttf][], Fonts addon for SDL2, 15 - [SDL2_ttf][], Fonts addon for SDL2,
16 - [gettext][], For translations (optional). 16 - [gettext][], For translations (optional).
17 - [zstd][], For compression (optional). 17 - [zstd][], For compression (optional).
18 18
19 Molko's Adventure is mostly written in pure C11 with a very limited POSIX 19 Molko's Engine is mostly written in pure C99 with a very limited POSIX
20 extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is 20 extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is
21 missing fallback implementations are provided. 21 missing fallback implementations are provided.
22 22
23 Supported platforms 23 Supported platforms
24 ------------------- 24 -------------------
39 $ tar xvzf molko-x.y.z-tar.xz 39 $ tar xvzf molko-x.y.z-tar.xz
40 $ cd molko-x.y.z 40 $ cd molko-x.y.z
41 $ cmake -S. -Bbuild 41 $ cmake -S. -Bbuild
42 $ cmake --build build --target all 42 $ cmake --build build --target all
43 # cmake --build build --target install 43 # cmake --build build --target install
44 $ mlk-adventure
45 44
46 Available options 45 Available options
47 ----------------- 46 -----------------
48 47
49 The following options are available: 48 The following options are available:
50 49
51 - `MLK_WITH_NLS`: Enable Native Language Support 50 - `MLK_WITH_NLS`: Enable Native Language Support
52 - `MLK_WITH_ZSTD`: Enable map and tileset compression through [zstd][] (default: 51 - `MLK_WITH_ZSTD`: Enable map and tileset compression through [zstd][] (default:
53 on). 52 on).
54 - `MLK_WITH_TESTS`: Enable unit tests (default: off). 53 - `MLK_WITH_TESTS`: Enable unit tests (default: off).
55 - `MLK_WITH_EXAMPLES`: Enable sample programs. 54 - `MLK_WITH_EXAMPLES`: Enable sample programs.
56
57 Direct use in source tree
58 -------------------------
59
60 Examples and `mlk-adventure` executables are written outside of the CMake build
61 tree and generated directly in the source tree. This is designed to search data
62 without installing.
63 55
64 Platform: Linux and BSD 56 Platform: Linux and BSD
65 ----------------------- 57 -----------------------
66 58
67 Install dependencies using the package manager provided and use CMake to 59 Install dependencies using the package manager provided and use CMake to