Mercurial > molko
diff INSTALL.md @ 366:19782ea1cf4a
misc: start rebranding
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 24 Oct 2021 15:57:42 +0200 |
parents | 06782f7888f3 |
children | 7ac4b10eedbe |
line wrap: on
line diff
--- a/INSTALL.md Sun Oct 24 12:59:02 2021 +0200 +++ b/INSTALL.md Sun Oct 24 15:57:42 2021 +0200 @@ -1,12 +1,12 @@ -Molko's Adventure INSTALL -========================= +Molko's Engine INSTALL +====================== Installation instructions. Requirements ------------ -- C11 compliant compiler. +- C99 compliant compiler. - [CMake][], CMake build system. - [Jansson][], JSON parsing library. - [SDL2][], Multimedia library. @@ -16,7 +16,7 @@ - [gettext][], For translations (optional). - [zstd][], For compression (optional). -Molko's Adventure is mostly written in pure C11 with a very limited POSIX +Molko's Engine is mostly written in pure C99 with a very limited POSIX extensions (including `stat`, `strlcpy`, `fmemopen`) but where support is missing fallback implementations are provided. @@ -41,26 +41,18 @@ $ cmake -S. -Bbuild $ cmake --build build --target all # cmake --build build --target install - $ mlk-adventure Available options ----------------- The following options are available: -- `MLK_WITH_NLS`: Enable Native Language Support +- `MLK_WITH_NLS`: Enable Native Language Support - `MLK_WITH_ZSTD`: Enable map and tileset compression through [zstd][] (default: on). - `MLK_WITH_TESTS`: Enable unit tests (default: off). - `MLK_WITH_EXAMPLES`: Enable sample programs. -Direct use in source tree -------------------------- - -Examples and `mlk-adventure` executables are written outside of the CMake build -tree and generated directly in the source tree. This is designed to search data -without installing. - Platform: Linux and BSD -----------------------