Skip to content

Commit 3a7ba70

Browse files
committed
Update some README details.
1 parent 6710e60 commit 3a7ba70

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,10 @@ x86_64 and M1 hardware. This should enable the code to run on:
5353
* iPad Mini (2 or later)
5454
* iPad Pro (all models)
5555
* iPod Touch (7th gen or later)
56-
* tvOS 9.0 or later, on Apple TV (4th gen or later)
57-
* watchOS 4.0 or later, on Apple Watch (4th gen or later)
56+
* tvOS 9.0 or later, on:
57+
* Apple TV (4th gen or later)
58+
* watchOS 4.0 or later, on:
59+
* Apple Watch (4th gen or later)
5860

5961
Quickstart
6062
----------
@@ -87,24 +89,22 @@ in the ``dist`` folder.
8789

8890
Each support package contains:
8991

90-
* ``VERSIONS``, a text file describing the specific versions of code used to
91-
build the support package;
92+
* ``VERSIONS``, a text file describing the specific versions of code used to build the
93+
support package;
94+
* ``platform-site``, a folder that contains site customization scripts that can be used
95+
to make your local Python install look like it is an on-device install for each of the
96+
underlying target architectures supported by the platform. This is needed because when
97+
you run ``pip`` you'll be on a macOS machine with a specific architecture; if ``pip``
98+
tries to install a binary package, it will install a macOS binary wheel (which won't
99+
work on iOS/tvOS/watchOS). However, if you add the ``platform-site`` folder to your
100+
``PYTHONPATH`` when invoking pip, the site customization will make your Python install
101+
return ``platform`` and ``sysconfig`` responses consistent with on-device behavior,
102+
which will cause ``pip`` to install platform-appropriate packages.
92103
* ``Python.xcframework``, a multi-architecture build of the Python runtime library
93-
* ``python-stdlib``, the code and binary modules comprising the Python standard
94-
library. On iOS, tvOS and watchOS, there are 2 copies of every binary module -
95-
one for physical devices, and one for the simulator. The simulator binaries
96-
are "fat", containing code for both x86_64 and arm64.
97-
98-
Non-macOS platforms also contain a ``platform-site`` folder. This contains a
99-
site customization script that can be used to make your local Python install
100-
look like it is an on-device install. This is needed because when you run
101-
``pip`` you'll be on a macOS machine; if ``pip`` tries to install a binary
102-
package, it will install a macOS binary wheel (which won't work on
103-
iOS/tvOS/watchOS). However, if you add the ``platform-site`` folder to your
104-
``PYTHONPATH`` when invoking pip, the site customization will make your Python
105-
install return ``platform`` and ``sysconfig`` responses consistent with
106-
on-device behavior, which will cause ``pip`` to install platform-appropriate
107-
packages.
104+
* ``python-stdlib``, the code and binary modules comprising the Python standard library.
105+
On iOS, tvOS and watchOS, there are 2 copies of every binary module - one for physical
106+
devices, and one for the simulator. The simulator binaries are "fat", containing code
107+
for both x86_64 and arm64.
108108

109109
For a detailed instructions on using the support package in your own project,
110110
see the `usage guide <./USAGE.md>`__
@@ -115,8 +115,8 @@ Building binary wheels
115115
When building binary wheels, you may need to use the libraries built by this
116116
project as inputs (e.g., the `cffi` module uses `libffi`). To support this, this
117117
project is able to package these dependencies as "wheels" that can be added to
118-
the `server/pypi/dist` directory of the `binary dependency builder
119-
project <https://github.com/freakboy3742/chaquopy>`__.
118+
the ``dist`` directory of the `Mobile Forge
119+
project <https://github.com/beeware/mobile-forge>`__.
120120

121121
To build these wheels, run:
122122

0 commit comments

Comments
 (0)