aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2021-10-10 07:20:17 -0400
committerGitHub <noreply@github.com>2021-10-10 14:20:17 +0300
commit2a2c246df2b73f759cfa5ae10421c04659fdc806 (patch)
tree9d43181ca32849635562947a0d8512931d900ebc
parent77ef437cc46954fddc23402a50931a700c9dd187 (diff)
downloadmeson-2a2c246df2b73f759cfa5ae10421c04659fdc806.zip
meson-2a2c246df2b73f759cfa5ae10421c04659fdc806.tar.gz
meson-2a2c246df2b73f759cfa5ae10421c04659fdc806.tar.bz2
Zipapp docs (#9356)
* Revert "README: Don't recommend using as a standalone script" This reverts commit 9763bf65c6285176b578de71b0c3b8c14c72fdf2. zipapps work fine now that we have a single entry point. Time to recommend them again. * update zipapp documentation to recommend the current packaging script Also update the website documentation to mention this at all.
-rw-r--r--README.md8
-rw-r--r--docs/markdown/Getting-meson.md12
2 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index c08c6ff..aac22b0 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,14 @@ python3 -m pip install ninja
More on Installing Meson build can be found at the
[getting meson page](https://mesonbuild.com/Getting-meson.html).
+#### Creating a standalone script
+
+Meson can be run as a [Python zip
+app](https://docs.python.org/3/library/zipapp.html). To generate the
+executable run the following command:
+
+ ./packaging/create_zipapp.py --outfile meson.pyz --interpreter '/usr/bin/env python3' <source checkout>
+
#### Running
Meson requires that you have a source directory and a build directory
diff --git a/docs/markdown/Getting-meson.md b/docs/markdown/Getting-meson.md
index 23f11ee..ec6f1c6 100644
--- a/docs/markdown/Getting-meson.md
+++ b/docs/markdown/Getting-meson.md
@@ -21,6 +21,17 @@ we strive to ensure that it will always be working and usable. All
commits go through a pull-request process that runs CI and tests
several platforms.
+### Packing Meson into a zipapp
+
+After downloading the release, you can create a standalone single-file
+executable for Meson by running the script:
+
+```
+./packaging/create_zipapp.py --outfile meson.pyz --interpreter '/usr/bin/env python3' <source checkout>
+```
+
+This uses python's native support for [zipapp].
+
## Installing Meson with pip
Meson is available in the [Python Package Index] and can be installed
@@ -92,6 +103,7 @@ provide Python 3. Use either `mingw32/mingw-w64-i686-python3` or
are building for.
[GitHub release page]: https://github.com/mesonbuild/meson/releases
+ [zipapp]: https://docs.python.org/3/library/zipapp.html
[Python Package Index]: https://pypi.python.org/pypi/meson/
[Git]: https://github.com/mesonbuild/meson
[Python's home page]: https://www.python.org/downloads/