Skip to content

Commit a8c93fe

Browse files
committed
Formatting fix to README.
1 parent a1f3b83 commit a8c93fe

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.rst

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,28 @@ repository:
1414

1515
It works by downloading, patching, and building a fat binary of Python and
1616
selected pre-requisites, and packaging them as static libraries that can be
17-
incorporated into an XCode project. The binary modules in the Python standard
17+
incorporated into an Xcode project. The binary modules in the Python standard
1818
library are statically compiled, but are distribted as ``.so`` objects that
1919
can be dynamically loaded at runtime.
2020

2121
It exposes *almost* all the modules in the Python standard library except for:
22-
* dbm.gnu
23-
* tkinter
24-
* readline
25-
* nis (Deprecated by PEP594)
26-
* ossaudiodev (Deprecated by PEP594)
27-
* spwd (Deprecated by PEP594)
22+
23+
* ``dbm.gnu``
24+
* ``tkinter``
25+
* ``readline``
26+
* ``nis`` (Deprecated by PEP594)
27+
* ``ossaudiodev`` (Deprecated by PEP594)
28+
* ``spwd`` (Deprecated by PEP594)
2829

2930
The following standard library modules are available on macOS, but not the other
3031
Apple platforms:
31-
* curses
32-
* grp
33-
* multiprocessing
34-
* posixshmem
35-
* posixsubprocess
36-
* syslog
32+
33+
* ``curses``
34+
* ``grp``
35+
* ``multiprocessing``
36+
* ``posixshmem``
37+
* ``posixsubprocess``
38+
* ``syslog``
3739

3840
The binaries support x86_64 and arm64 for macOS; arm64 for iOS and appleTV
3941
devices; and arm64_32 for watchOS. It also supports device simulators on both
@@ -60,7 +62,7 @@ Quickstart
6062

6163
The easist way to use these packages is by creating a project with `Briefcase
6264
<https://github.com/beeware/briefcase>`__. Briefcase will download pre-compiled
63-
versions of these support packages, and add them to an XCode project (or
65+
versions of these support packages, and add them to an Xcode project (or
6466
pre-build stub application, in the case of macOS).
6567

6668
Pre-built versions of the frameworks can be downloaded from the `Github releases page
@@ -69,17 +71,17 @@ Pre-built versions of the frameworks can be downloaded from the `Github releases
6971
Alternatively, to build the frameworks on your own, download/clone this
7072
repository, and then in the root directory, and run:
7173

72-
* `make` (or `make all`) to build everything.
73-
* `make macOS` to build everything for macOS.
74-
* `make iOS` to build everything for iOS.
75-
* `make tvOS` to build everything for tvOS.
76-
* `make watchOS` to build everything for watchOS.
74+
* ``make`` (or ``make all``) to build everything.
75+
* ``make macOS`` to build everything for macOS.
76+
* ``make iOS`` to build everything for iOS.
77+
* ``make tvOS`` to build everything for tvOS.
78+
* ``make watchOS`` to build everything for watchOS.
7779

7880
This should:
7981

8082
1. Download the original source packages
8183
2. Patch them as required for compatibility with the selected OS
82-
3. Build the packages as XCode-compatible XCFrameworks.
84+
3. Build the packages as Xcode-compatible XCFrameworks.
8385

8486
The resulting support packages will be packaged as a ``.tar.gz`` file
8587
in the ``dist`` folder.
@@ -119,10 +121,10 @@ project <https://github.com/freakboy3742/chaquopy>`__.
119121

120122
To build these wheels, run:
121123

122-
* `make wheels` to make all wheels for all mobile platforms
123-
* `make wheels-iOS` to build all the iOS wheels
124-
* `make wheels-tvOS` to build all the tvOS wheels
125-
* `make wheels-watchOS` to build all the watchOS wheels
124+
* ``make wheels`` to make all wheels for all mobile platforms
125+
* ``make wheels-iOS`` to build all the iOS wheels
126+
* ``make wheels-tvOS`` to build all the tvOS wheels
127+
* ``make wheels-watchOS`` to build all the watchOS wheels
126128

127129
Historical support
128130
------------------

0 commit comments

Comments
 (0)