blob: e65cc8e1f5df0937cb838473fa0367907895e26d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
## Minimum build requirements
- C/C++ compiler with support for C++14
- SDL >= 2.0.2
- Opusfile
- Meson >= 0.49.0 or Visual Studio Community Edition
- OS that is mostly POSIX-compliant or up-to-date Windows system
All other dependencies are optional and can be disabled while configuring the
build (in `meson setup` step).
## OS-specific instructions
Instructions in this article assume you're using Linux or BSD but will work
on any modern system. Documentation for programmers using other systems:
[Windows], [macOS], [Haiku].
[Windows]: docs/build-windows.md
[macOS]: docs/build-macos.md
[Haiku]: docs/build-haiku.md
## Meson build snippets
### Make a debug build
Install dependencies listed in [README.md](README.md). Although `ccache` is
optional, we recommend installing it because Meson will use it to greatly speed
up builds.
Build steps:
``` shell
meson setup build
ninja -C build
```
Directory `build` will contain all compiled files.
### Other build types
Meson supports several build types, appropriate for various situations:
`release` for creating optimized release binaries, `debug` (default) for
for development or `plain` for packaging.
``` shell
meson setup -Dbuildtype=release build
```
Detailed documentation: [Meson: Core options][meson-core]
[meson-core]: https://mesonbuild.com/Builtin-options.html#core-options
### Disabling unwanted dependencies
The majority of dependencies are optional and can be disabled during build.
For example, to compile without OpenGL dependency try:
``` shell
meson setup -Duse_opengl=false build
ninja -C build
```
See file [`meson_options.txt`](meson_options.txt) for list of all available
project-specific build options.
You can also run `meson configure` to see the list of *all* available
build options (including project-specific ones).
### Run unit tests
Prerequisites:
``` shell
# Fedora
sudo dnf install gtest-devel
```
``` shell
# Debian, Ubuntu
sudo apt install libgtest-dev
```
If `gtest` is not available/installed on the OS, Meson will download it
automatically.
Build and run tests:
``` shell
meson setup build
meson test -C build
```
### Run unit tests (with user-supplied gtest sources)
*Appropriate during packaging or when user is behind a proxy or without
internet access.*
Place files described in `subprojects/gtest.wrap` file in
`subprojects/packagecache/` directory, and then:
``` shell
meson setup --wrap-mode=nodownload build
meson test -C build
```
### Build test coverage report
Prerequisites:
``` shell
# Fedora
sudo dnf install gcovr lcov
```
Run tests and generate report:
``` shell
meson setup -Db_coverage=true build
meson test -C build
ninja -C build coverage-html
```
Open the report with your browser:
``` shell
firefox build/meson-logs/coveragereport/index.html"
```
### Static analysis report
Prerequisites:
``` shell
# Fedora
sudo dnf install clang-analyzer
```
``` shell
# Debian, Ubuntu
sudo apt install clang-tools
```
Build and generate report:
``` shell
meson setup build
ninja -C build scan-build
```
|
