Mercurial > molko

comparison INSTALL.md @ 308:8523fb0c8540

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
make: add run target
author David Demelier <markand@malikania.fr>
date Fri, 09 Jul 2021 11:29:36 +0200
parents 363024b76da7
children 3bfaaf5342a9
comparison
equal deleted inserted replaced
307:363024b76da7 308:8523fb0c8540
30 30
31 - `all`: (default): build only molko. 31 - `all`: (default): build only molko.
32 - `tools`: build tools (e.g. molko-map). 32 - `tools`: build tools (e.g. molko-map).
33 - `tests`: build tests and run them. 33 - `tests`: build tests and run them.
34 - `everything`: build molko, tools and tests without running them. 34 - `everything`: build molko, tools and tests without running them.
35 - `fakeroot`: create a runnable local directory. 35 - `run`: run molko with data installed in the source tree.
36 36
37 Direct use in source tree 37 Direct use in source tree
38 ------------------------- 38 -------------------------
39 39
40 Examples and `mlk-adventure` executable searches for data into a specific 40 Examples and `mlk-adventure` executable searches for data into a specific
43 43
44 You need to install at least the data once using `install-data` target, you can 44 You need to install at least the data once using `install-data` target, you can
45 do this without root access by using a temporary directory and set the 45 do this without root access by using a temporary directory and set the
46 `MLK_ROOT` environment variable. 46 `MLK_ROOT` environment variable.
47 47
48 $ make DESTDIR=datadir install 48 The directory `out` is recommended, see below.
49 $ MLK_ROOT=datadir ./mlk-adventure/mlk-adventure
50 (or to run examples)
51 $ MLK_ROOT=datadir ./examples/
52 49
53 Note: you need rsync installed, in contrast to `install` with a `DESTDIR` 50 $ make DESTDIR=out install-data
54 macro it only copies runtime data and avoid re-copying what didn't 51 $ MLK_ROOT=out ./mlk-adventure/mlk-adventure
55 change for a faster experience. 52 (or to run examples:)
53 $ MLK_ROOT=out ./examples/example-action/main
56 54
57 $ make all examples 55 There is a special target `run` that automatically create the diretory `out`
58 $ ./fakeroot/bin/mlk-adventure 56 with all data and binaries installed and runs `mlk-adventure`.
59 (or)
60 $ ./fakeroot/bin/example-action
61 57
62 Platform: Windows 58 Platform: Windows
63 ----------------- 59 -----------------
64 60
65 On Windows, only [MSYS2][] is supported. 61 On Windows, only [MSYS2][] is supported.