Cleaning project readme [skip ci]

pull/6585/head
Michael Brockus 5 years ago committed by GitHub
parent 1f7e73fd5c
commit 1ea20a37d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 52
      README.md

@ -20,27 +20,28 @@ build system.
#### 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 command
Meson is available on [PyPi](https://pypi.python.org/pypi/meson), so
it can be installed with `pip3 install meson`. The exact command to
type to install with `pip` can vary between systems, be sure to use
the Python 3 version of `pip`.
```sh
python3 -m pip install meson <your options here>
```
If you wish you can install it locally with the standard Python command:
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.
```console
python3 -m pip install meson
```
For builds using Ninja, Ninja can be [downloaded directly](https://github.com/ninja-build/ninja/releases) or via
For builds using Ninja, Ninja can be downloaded directly from Ninja
[GitHub release page](https://github.com/ninja-build/ninja/releases)
or via [PyPi](https://pypi.python.org/pypi/ninja)
```sh
```console
python3 -m pip install ninja
```
More on Installing Meson build can be found at the
[getting meson page](https://mesonbuild.com/Getting-meson.html).
#### Running
Meson requires that you have a source directory and a build directory
@ -58,27 +59,22 @@ 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`
```console
cd <source root>
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.
More on running Meson build system commands can be found at the
[running meson page](https://mesonbuild.com/Running-Meson.html)
or by typing `meson --help`.
#### Contributing
We love code contributions. See the [contribution
page](https://mesonbuild.com/Contributing.html) on the web site for
page](https://mesonbuild.com/Contributing.html) on the website for
details.
@ -96,4 +92,4 @@ to connect to this channel.
More information about the Meson build system can be found at the
[project's home page](https://mesonbuild.com).
Meson is a registered trademark of Jussi Pakkanen.
Meson is a registered trademark of ***Jussi Pakkanen***.

Loading…
Cancel
Save