Fix last mention of Python 3.5. [skip ci]

pull/8163/head
Jussi Pakkanen 4 years ago committed by Dylan Baker
parent 1c60fdd847
commit f9dd75f213
  1. 105
      docs/markdown/Getting-meson.md

@ -1,86 +1,93 @@
# Getting meson # Getting meson
Meson is implemented in Python 3, and requires 3.5 or newer. If your operating Meson is implemented in Python 3, and requires 3.6 or newer. If your
system provides a package manager, you should install it with that. For operating system provides a package manager, you should install it
platforms that don't have a package manager, you need to download it from with that. For platforms that don't have a package manager, you need
[Python's home page]. See below for [platform-specific Python3 to download it from [Python's home page]. See below for
quirks](#platformspecific-install-quirks). [platform-specific Python3 quirks](#platformspecific-install-quirks).
## Downloading Meson ## Downloading Meson
Meson releases can be downloaded from the [GitHub release page], and you can Meson releases can be downloaded from the [GitHub release page], and
run `./meson.py` from inside a release or the git repository itself without you can run `./meson.py` from inside a release or the git repository
doing anything special. itself without doing anything special.
On Windows, if you did not install Python with the installer options that make On Windows, if you did not install Python with the installer options
Python scripts executable, you will have to run `python /path/to/meson.py`, that make Python scripts executable, you will have to run `python
where `python` is Python 3.5 or newer. /path/to/meson.py`, where `python` is Python 3.6 or newer.
The newest development code can be obtained directly from [Git], and we strive The newest development code can be obtained directly from [Git], and
to ensure that it will always be working and usable. All commits go through we strive to ensure that it will always be working and usable. All
a pull-request process that runs CI and tests several platforms. commits go through a pull-request process that runs CI and tests
several platforms.
## Installing Meson with pip ## Installing Meson with pip
Meson is available in the [Python Package Index] and can be installed with Meson is available in the [Python Package Index] and can be installed
`sudo pip3 install meson` which requires root and will install it system-wide. with `sudo pip3 install meson` which requires root and will install it
system-wide.
If you have downloaded a copy of the meson sources already, you can install it If you have downloaded a copy of the meson sources already, you can
with `sudo pip3 install path/to/source/root/`. install it with `sudo pip3 install path/to/source/root/`.
Alternatively, you can use `pip3 install --user meson` which will install it Alternatively, you can use `pip3 install --user meson` which will
for your user and does not require any special privileges. This will install install it for your user and does not require any special
the package in `~/.local/`, so you will have to add `~/.local/bin` to your privileges. This will install the package in `~/.local/`, so you will
`PATH`, and `sudo meson install` will be completely broken since the have to add `~/.local/bin` to your `PATH`, and `sudo meson install`
program will not be available to root. Only use a user copy of meson if you will be completely broken since the program will not be available to
do not care about installing projects as root. root. Only use a user copy of meson if you do not care about
installing projects as root.
## Installing Meson and Ninja with the MSI installer ## Installing Meson and Ninja with the MSI installer
We provide an MSI installer on the [GitHub release page] that can be used to We provide an MSI installer on the [GitHub release page] that can be
install both Meson and Ninja at once for Windows. It also contains an embedded used to install both Meson and Ninja at once for Windows. It also
copy of Python, so scripts that use the [Python module](Python-module.md) and contains an embedded copy of Python, so scripts that use the [Python
do not have any external dependencies will continue to work as expected. module](Python-module.md) and do not have any external dependencies
will continue to work as expected.
Please note that this is a new feature, so bug reports are expected and welcome! Please note that this is a new feature, so bug reports are expected
and welcome!
## Dependencies ## Dependencies
In the most common case, you will need the [Ninja executable] for using the In the most common case, you will need the [Ninja executable] for
`ninja` backend, which is the default in Meson. This backend can be used on all using the `ninja` backend, which is the default in Meson. This backend
platforms and with all toolchains, including GCC, Clang, Visual Studio, MinGW, can be used on all platforms and with all toolchains, including GCC,
ICC, ARMCC, etc. Clang, Visual Studio, MinGW, ICC, ARMCC, etc.
You can use the version provided by your package manager if possible, otherwise You can use the version provided by your package manager if possible,
download the binary executable from the [Ninja project's release otherwise download the binary executable from the [Ninja project's
page](https://github.com/ninja-build/ninja/releases). release page](https://github.com/ninja-build/ninja/releases).
If you will only use the Visual Studio backend (`--backend=vs`) to generate If you will only use the Visual Studio backend (`--backend=vs`) to
Visual Studio solutions on Windows or the XCode backend (`--backend=xcode`) to generate Visual Studio solutions on Windows or the XCode backend
generate XCode projects on macOS, you do not need Ninja. (`--backend=xcode`) to generate XCode projects on macOS, you do not
need Ninja.
# Platform-specific install quirks # Platform-specific install quirks
## Windows Python3 quirks ## Windows Python3 quirks
When installing Python 3, it is highly recommended (but not required) that you When installing Python 3, it is highly recommended (but not required)
select the installer options as follows: that you select the installer options as follows:
![installer step 1](images/py3-install-1.png "Enable 'Add Python 3.6 to PATH' and click 'Customize installation'") ![installer step 1](images/py3-install-1.png "Enable 'Add Python 3.6 to PATH' and click 'Customize installation'")
![installer step 2](images/py3-install-2.png "Optional Features: ensure 'pip' is enabled") ![installer step 2](images/py3-install-2.png "Optional Features: ensure 'pip' is enabled")
![installer step 3](images/py3-install-3.png "Advanced Options: enable 'Install for all users'") ![installer step 3](images/py3-install-3.png "Advanced Options: enable 'Install for all users'")
With this, you will have `python` and `pip` in `PATH`, and you can install With this, you will have `python` and `pip` in `PATH`, and you can
Meson with pip. You will also be able to directly run `meson` in any shell on install Meson with pip. You will also be able to directly run `meson`
Windows instead of having to run `py -3` with the full path to the `meson.py` in any shell on Windows instead of having to run `py -3` with the full
script. path to the `meson.py` script.
## MSYS2 Python3 quirks ## MSYS2 Python3 quirks
If you are using MSYS2 on Windows as your development environment, please make If you are using MSYS2 on Windows as your development environment,
sure that you **do not use** the `msys/python` package to provide Python 3. Use please make sure that you **do not use** the `msys/python` package to
either `mingw32/mingw-w64-i686-python3` or `mingw64/mingw-w64-x86_64-python3` provide Python 3. Use either `mingw32/mingw-w64-i686-python3` or
depending on which MinGW target you are building for. `mingw64/mingw-w64-x86_64-python3` depending on which MinGW target you
are building for.
[GitHub release page]: https://github.com/mesonbuild/meson/releases [GitHub release page]: https://github.com/mesonbuild/meson/releases
[Python Package Index]: https://pypi.python.org/pypi/meson/ [Python Package Index]: https://pypi.python.org/pypi/meson/

Loading…
Cancel
Save