summaryrefslogtreecommitdiffstats
path: root/Android
diff options
context:
space:
mode:
authorMalcolm Smith <smith@chaquo.com>2024-09-23 23:09:53 (GMT)
committerGitHub <noreply@github.com>2024-09-23 23:09:53 (GMT)
commite80dd3035fb805716bc49f9e7e9cab5f83614661 (patch)
tree98794da74d73663f00425a02fd137c59ea4a6f47 /Android
parent27a62e7371f062a80704f6bf4d6e8f06568d37aa (diff)
downloadcpython-e80dd3035fb805716bc49f9e7e9cab5f83614661.zip
cpython-e80dd3035fb805716bc49f9e7e9cab5f83614661.tar.gz
cpython-e80dd3035fb805716bc49f9e7e9cab5f83614661.tar.bz2
gh-116622: Complete Android documentation (#124259)
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: T. Wouters <thomas@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Diffstat (limited to 'Android')
-rw-r--r--Android/README.md23
1 files changed, 12 insertions, 11 deletions
diff --git a/Android/README.md b/Android/README.md
index f9e3f29..3daa545 100644
--- a/Android/README.md
+++ b/Android/README.md
@@ -1,13 +1,9 @@
# Python for Android
These instructions are only needed if you're planning to compile Python for
-Android yourself. Most users should *not* need to do this. If you're looking to
-use Python on Android, one of the following tools will provide a much more
-approachable user experience:
-
-* [Briefcase](https://briefcase.readthedocs.io), from the BeeWare project
-* [Buildozer](https://buildozer.readthedocs.io), from the Kivy project
-* [Chaquopy](https://chaquo.com/chaquopy/)
+Android yourself. Most users should *not* need to do this. Instead, use one of
+the tools listed in `Doc/using/android.rst`, which will provide a much easier
+experience.
## Prerequisites
@@ -89,10 +85,10 @@ The test suite can be run on Linux, macOS, or Windows:
The test suite can usually be run on a device with 2 GB of RAM, but this is
borderline, so you may need to increase it to 4 GB. As of Android
Studio Koala, 2 GB is the default for all emulators, although the user interface
-may indicate otherwise. The effective setting is `hw.ramSize` in
-~/.android/avd/*.avd/hardware-qemu.ini, whereas Android Studio displays the
-value from config.ini. Changing the value in Android Studio will update both of
-these files.
+may indicate otherwise. Locate the emulator's directory under `~/.android/avd`,
+and find `hw.ramSize` in both config.ini and hardware-qemu.ini. Either set these
+manually to the same value, or use the Android Studio Device Manager, which will
+update both files.
Before running the test suite, follow the instructions in the previous section
to build the architecture you want to test. Then run the test script in one of
@@ -133,3 +129,8 @@ Every time you run `android.py test`, changes in pure-Python files in the
repository's `Lib` directory will be picked up immediately. Changes in C files,
and architecture-specific files such as sysconfigdata, will not take effect
until you re-run `android.py make-host` or `build`.
+
+
+## Using in your own app
+
+See `Doc/using/android.rst`.