The Meson Build System
http://mesonbuild.com/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
3.3 KiB
88 lines
3.3 KiB
<p align="center"> |
|
<img src="http://mesonbuild.com/assets/images/meson_logo.png"> |
|
</p> |
|
Meson® is a project to create the best possible next-generation |
|
build system. |
|
|
|
#### Status |
|
|
|
[![PyPI](https://img.shields.io/pypi/v/meson.svg)](https://pypi.python.org/pypi/meson) |
|
[![Travis](https://travis-ci.org/mesonbuild/meson.svg?branch=master)](https://travis-ci.org/mesonbuild/meson) |
|
[![Appveyor](https://ci.appveyor.com/api/projects/status/7jfaotriu8d8ncov?svg=true)](https://ci.appveyor.com/project/mesonbuild/meson) |
|
[![Build Status](https://dev.azure.com/jussi0947/jussi/_apis/build/status/mesonbuild.meson)](https://dev.azure.com/jussi0947/jussi/_build/latest?definitionId=1) |
|
[![Codecov](https://codecov.io/gh/mesonbuild/meson/coverage.svg?branch=master)](https://codecov.io/gh/mesonbuild/meson/branch/master) |
|
[![Code Quality: Python](https://img.shields.io/lgtm/grade/python/g/mesonbuild/meson.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mesonbuild/meson/context:python) |
|
[![Total Alerts](https://img.shields.io/lgtm/alerts/g/mesonbuild/meson.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mesonbuild/meson/alerts) |
|
|
|
#### Dependencies |
|
|
|
- [Python](http://python.org) (version 3.5 or newer) |
|
- [Ninja](https://ninja-build.org) (version 1.5 or newer) |
|
|
|
#### Installing from source |
|
|
|
You can run Meson directly from a revision control checkout or an |
|
extracted tarball. If you wish you can install it locally with the |
|
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 `pip3 install meson` (this does not require a source checkout, |
|
pip will download the package automatically). The exact command to |
|
type to install with pip can vary between systems, be sure to use the |
|
Python 3 version of pip. |
|
|
|
#### 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>` |
|
|
|
Depending on how you obtained Meson the command might also be called |
|
`meson.py` instead of plain `meson`. In the rest of this document we |
|
are going to use the latter form. |
|
|
|
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 builddir; cd builddir; meson ..` |
|
|
|
or |
|
|
|
`cd source_root; mkdir builddir; meson builddir` |
|
|
|
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.md](contributing.md) file for |
|
details. |
|
|
|
|
|
#### IRC |
|
|
|
The irc channel for Meson is `#mesonbuild` over at Freenode. |
|
|
|
You can use [FreeNode's official webchat](https://webchat.freenode.net/#mesonbuild) |
|
to connect to this channel. |
|
|
|
|
|
#### 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.
|
|
|