aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d1fcb2f159beef9fc18813e69e5520e51d5ba579 (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
<p align="center">
<img src="http://mesonbuild.com/meson_logo.png">
</p>
MesonĀ® is a project to create the best possible next-generation
build system.

####Dependencies

 - [Python](http://python.org) (version 3.4 or newer)
 - [Ninja](http://martine.github.com/ninja/)

####Installing from source

You can run Meson directly from a revision control checkout or an
extracted tarball. You can also install it locally with standard
Python distutils command `python3 setup.py install <your options
here>`.

Meson is also available from
[PyPi](https://pypi.python.org/pypi/meson), so it can be installed
with `pip install meson` (this does not require a source checkout, pip
will download the package automatically).

####Running

Meson requires that you have a source directory and a build directory
and that these two are different. In your source root must exist a file
called 'meson.build'. To generate the build system run this command:

`meson <source directory> <build directory>`

You can omit either of the two directories, and Meson will substitute
the current directory and autodetect what you mean. This allows you to
do things like this:

`cd source_root; mkdir build; cd build; meson ..`

`cd source_root; mkdir build; meson build`

To compile, cd into your build directory and type `ninja`. To run unit
tests, type `ninja test`.

Install is the same but it can take an extra argument:

`DESTDIR=/destdir/path ninja install`

`DESTDIR` can be omitted. If you are installing to system directories,
you may need to run this command with sudo.


####Contributing

We love code contributions. See the contributing.txt file for
details.


####IRC

The irc channel for Meson is `#mesonbuild` over at Freenode.


####Further info

More information about the Meson build system can be found at the
[project's home page](http://mesonbuild.com).

Meson is a registered trademark of Jussi Pakkanen