aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Brockus <55331536+michaelbadcrumble@users.noreply.github.com>2020-02-03 14:51:11 -0800
committerGitHub <noreply@github.com>2020-02-04 00:51:11 +0200
commit1ea20a37d7d7041d045dfa46eebb22108569bb48 (patch)
tree89360ae26ab40f70e5fd6031cb29c487163b526b /README.md
parent1f7e73fd5cd7b85d4c7d179c9299e13189b8556d (diff)
downloadmeson-1ea20a37d7d7041d045dfa46eebb22108569bb48.zip
meson-1ea20a37d7d7041d045dfa46eebb22108569bb48.tar.gz
meson-1ea20a37d7d7041d045dfa46eebb22108569bb48.tar.bz2
Cleaning project readme [skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 24 insertions, 28 deletions
diff --git a/README.md b/README.md
index 073dfa4..4996aa7 100644
--- a/README.md
+++ b/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***.