Skip to content

Commit 76fbbff

Browse files
committed
pyoxy: add installing docs
1 parent 5351714 commit 76fbbff

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

pyoxy/docs/pyoxy.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ PyOxidizer project, leveraging much of its *technology*.
1616
:maxdepth: 2
1717

1818
pyoxy_overview
19+
pyoxy_installing
1920
pyoxy_yaml
2021
pyoxy_developing

pyoxy/docs/pyoxy_installing.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _pyoxy_installing:
2+
3+
==========
4+
Installing
5+
==========
6+
7+
It is **highly recommended** to obtain and use one of the official pre-built
8+
binaries for PyOxy. These can be obtained from GitHub releases. Go to
9+
https://github.com/indygreg/PyOxidizer/releases and scroll until you find
10+
the latest release for PyOxy.
11+
12+
System Requirements
13+
===================
14+
15+
The requirements in this section only apply to the official pre-built
16+
binaries. Binaries built by others may not have the same requirements.
17+
18+
Linux
19+
-----
20+
21+
The x86_64-unknown-linux-gnu binaries should work on any Linux having
22+
glibc 2.18+ and GCC 4.2+ and conform to the Linux Standard Base Core
23+
Specification. This should be ~every Linux distribution released since
24+
2014-2015.
25+
26+
.. note::
27+
28+
Modern versions of Fedora / CentOS / RHEL have a bug and
29+
`don't conform to the LSB Core Specification <https://bugzilla.redhat.com/show_bug.cgi?id=2055953>`_
30+
unless you install the ``libxcrypt-compat`` package. If you see
31+
an error about missing ``libcrypt.so.1``, your distribution is buggy.
32+
33+
macOS
34+
-----
35+
36+
The x86_64-apple-darwin binaries target macOS 10.9+.
37+
38+
The aarch64-apple-darwin binaries target macOS 11.0+.
39+
40+
The binaries should work on a fresh install of macOS.

0 commit comments

Comments
 (0)