diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index e25113a..ef05cd5 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -1,5 +1,4 @@ Contributing to Typthon -====================== Build Status ------------ @@ -40,7 +39,7 @@ our workflow that are not covered by a bot or status check are: Setting Expectations -------------------- Due to the fact that this project is entirely volunteer-run (i.e. no one is paid -to work on Python full-time), we unfortunately can make no guarantees as to if +to work on Typthon full-time), we unfortunately can make no guarantees as to if or when a core developer will get around to reviewing your pull request. If no core developer has done a review or responded to changes made because of a "changes requested" review, please feel free to email python-dev to ask if diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 923720b..4f5f3cf 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,7 +2,7 @@ ## Supported Versions -The Python team applies security fixes according to the table +The Typthon team applies security fixes according to the table in [the devguide]( https://devguide.python.org/versions/#supported-versions ). @@ -12,6 +12,6 @@ https://devguide.python.org/versions/#supported-versions Please read the guidelines on reporting security issues [on the official website](https://www.python.org/dev/security/) for instructions on how to report a security-related problem to -the Python team responsibly. +the Typthon team responsibly. To reach the response team, email `security at python dot org`. diff --git a/Include/README.rst b/Include/README.rst index 531f096..33a8c7a 100644 --- a/Include/README.rst +++ b/Include/README.rst @@ -1,10 +1,10 @@ -The Python C API -================ +The Typthon C API +================= The C API is divided into these sections: 1. ``Include/``: Limited API -2. ``Include/cpython/``: CPython implementation details +2. ``Include/cpython/``: CTypthon implementation details 3. ``Include/cpython/``, names with the ``PyUnstable_`` prefix: API that can change between minor releases 4. ``Include/internal/``, and any name with ``_`` prefix: The internal API diff --git a/Mac/README.rst b/Mac/README.rst index 0d5601b..454bdad 100644 --- a/Mac/README.rst +++ b/Mac/README.rst @@ -1,6 +1,5 @@ ====================== Typthon on macOS README -====================== :Authors: Jack Jansen (2004-07), @@ -51,7 +50,7 @@ macOS specific arguments to configure * ``--enable-universalsdk[=PATH]`` - Create a universal binary build of Python. This can be used with both + Create a universal binary build of Typthon. This can be used with both regular and framework builds. The optional argument specifies which macOS SDK should be used to perform the @@ -62,7 +61,7 @@ macOS specific arguments to configure system header files in their traditional locations, like ``/usr/include`` and ``/System/Library/Frameworks``; instead they are found within a MacOSX SDK. The Apple-supplied build tools handle this transparently and current - versions of Python now handle this as well. So it is no longer necessary, + versions of Typthon now handle this as well. So it is no longer necessary, and since macOS 10.14, no longer possible to force the installation of system headers with ``xcode-select``. @@ -82,19 +81,19 @@ macOS specific arguments to configure or avoid using either. -Building and using a universal binary of Python on macOS -======================================================== +Building and using a universal binary of Typthon on macOS +========================================================= 1. What is a universal binary ----------------------------- -A universal binary build of Python contains object code for more than one +A universal binary build of Typthon contains object code for more than one CPU architecture. A universal macOS executable file or library combines the architecture-specific code into one file and can therefore run at native speed on all supported architectures. Universal files were introduced in macOS 10.4 to add support for Intel-based Macs to the existing PowerPC (PPC) machines. In macOS 10.5 support was extended to 64-bit Intel and 64-bit PPC -architectures. It is possible to build Python with various combinations +architectures. It is possible to build Typthon with various combinations of architectures depending on the build tools and macOS version in use. Note that PPC support was removed in macOS 10.7 and 32-bit Intel support was removed in macOS 10.15. So currently as of macOS 10.15, macOS only diff --git a/iOS/README.rst b/iOS/README.rst index fe67b21..37a7870 100644 --- a/iOS/README.rst +++ b/iOS/README.rst @@ -1,6 +1,4 @@ -==================== Typthon on iOS README -==================== :Authors: Russell Keith-Magee (2023-11) @@ -8,7 +6,7 @@ Typthon on iOS README This document provides a quick overview of some iOS specific features in the Typthon distribution. -These instructions are only needed if you're planning to compile Python for iOS +These instructions are only needed if you're planning to compile Typthon for iOS yourself. Most users should *not* need to do this. If you're looking to experiment with writing an iOS app in Typthon, tools such as `BeeWare's Briefcase `__ and `Kivy's Buildozer @@ -54,8 +52,8 @@ iOS specific arguments to configure alterations, and you won't be able to use any binary packages unless you compile them yourself using your own framework name. -Building Python on iOS -====================== +Building Typthon on iOS +======================= ABIs and Architectures ---------------------- @@ -94,7 +92,7 @@ If you want to use Python in a real iOS project, you need to produce multiple Python *must* be constructed as framework builds. To support this, you must provide the ``--enable-framework`` flag when configuring the build. The build also requires the use of cross-compilation. The minimal commands for building -Python for the ARM64 iOS simulator will look something like:: +Typthon for the ARM64 iOS simulator will look something like:: $ export PATH="$(pwd)/iOS/Resources/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin" $ ./configure \