diff options
| -rw-r--r-- | docs/markdown/Quick-guide.md | 74 |
1 files changed, 58 insertions, 16 deletions
diff --git a/docs/markdown/Quick-guide.md b/docs/markdown/Quick-guide.md index 84595ae..80d3740 100644 --- a/docs/markdown/Quick-guide.md +++ b/docs/markdown/Quick-guide.md @@ -1,44 +1,86 @@ --- -title: Quick guide -short-description: Guide to get started using meson +title: Quickstart Guide +short-description: Getting Started using Mesonbuild ... # Using Meson -Meson has been designed to be as easy to use as possible. This page -outlines the basic use cases. For more advanced cases refer to Meson's -command line help which is accessible with the command `meson --help`. +Meson has been designed to be as simple to use as possible. This page +outlines the initial steps needed for installation, troubleshooting, +and standard use. + +For more advanced configuration please refer to the command line help `meson --help` +or the Meson documentation located at the [Mesonbuild](https://mesonbuild.com) website. + +Table of Contents: +* [Requirements](#requirements) +* [Installation using package manager](#installation-using-package-manager) +* [Installation using Python](#installation-using-python) +* [Installation from source](#installation-from-source) +* [Troubleshooting](#troubleshooting) +* [Compiling a Meson project](#compiling-a-meson-project) +* [Using Meson as a distro packager](#using-meson-as-a-distro-packager) Requirements -- -Meson has two main dependencies. - * [Python 3](https://python.org) * [Ninja](https://github.com/ninja-build/ninja/) -Ninja is only needed if you use the Ninja backend. Meson can also -generate native VS and XCode project files. +*Ninja is only needed if you use the Ninja backend. Meson can also +generate native VS and XCode project files.* + + +Installation using package manager +-- -On Ubuntu these can be easily installed with the following command: +Ubuntu: ```console $ sudo apt-get install python3 python3-pip python3-setuptools \ python3-wheel ninja-build ``` +*Due to our frequent release cycle and development speed, distro packaged software may quickly become outdated.* + +Installation using Python +-- +Requirements: **pip3** -The best way to get Meson is to `pip install` it for your user +The best way to receive the most up-to-date version of Mesonbuild. +Install as a local user (recommended): ```console $ pip3 install --user meson ``` +Install as root: +```console +$ pip3 install meson +``` +*If you are unsure whether to install as root or a local user, install as a local user.* + +Installation from source +-- +Requirements: **git** + +Meson can be run directly from the cloned git repository. + +```console +$ git clone https://github.com/mesonbuild/meson.git /path/to/sourcedir +``` +Troubleshooting: +-- +Common Issues: +```console +$ meson builddir +$ bash: /usr/bin/meson: No such file or directory +``` +Description: The default installation prefix for the python pip module installation is not included in your shell environment PATH. The default prefix for python pip installation modules is located under ``/usr/local``. + +**Resolution: +This issue can be resolved by altering the default shell environment PATH to include ``/usr/local/bin``. ** -You can also use Meson as packaged by your distro, but beware that due -to our frequent release cycle and development speed this version might -be out of date. +*Note: There are other ways of fixing this issue such as using symlinks or copying the binaries to a default path and these methods are not recommended or supported as they may break package management interoperability.* -Another option is to clone the git repository and run it directly from -there. Compiling a Meson project -- |