Merge pull request #1003 from Zen-CODE/Doc_English_Improvements_6

Updated the 'Kivy on Android' documentaion
This commit is contained in:
qua-non 2013-03-12 00:30:00 -07:00
commit 514f61f0e7
1 changed files with 22 additions and 16 deletions

View File

@ -1,21 +1,22 @@
.. _android:
.. _Kivy Launcher: https://play.google.com/store/apps/details?id=org.kivy.pygame&hl=en
Kivy on Android
===============
Kivy is able to run on android, but you need a phone with:
Kivy runs on Android, but you need a phone with:
* SD Card
* OpenGL ES 2.0 (Android 2.2 minimum)
Requirements for android application
------------------------------------
Requirements for an Android application
---------------------------------------
To create an application for Android platform, you must have a
To create an application for the Android platform, you must have a
file named `main.py` in the root directory of your application.
If the application will run inside the Kivy launcher, then you must handle the
`__name__` as::
If you want your application to run inside the `Kivy launcher`_, then you
must handle the `__name__` as::
if __name__ in ('__main__', '__android__'):
YourApp().run()
@ -26,15 +27,19 @@ Create an APK
The whole process is described in the :ref:`packaging_android` documentation.
Debugging your application on android platform
----------------------------------------------
Debugging your application on the Android platform
--------------------------------------------------
Android SDK ship a tool named adb. Connect your device, and run::
The `Android SDK <http://developer.android.com/sdk/index.html>`_ includes a tool named adb.
Connect your device, and run::
adb logcat
You'll see all the log including your stdout/stderr, Kivy logger.
You'll see all the logs including your stdout/stderr, Kivy logger.
You can also run and debug your application using the `Kivy Launcher`_.
If you run your application this way, you will find log files inside the
"/.kivy/logs" sub-folder within your application folder.
Status of the Project
---------------------
@ -44,17 +49,17 @@ The project is now stable, using `Python for Android
We made that project to be able to:
- create custom Python version including only wanted modules
- handle multitouch events to Kivy
- create a python module for accessing to some intents
- create custom Python versions including only wanted modules
- handle multitouch events in Kivy
- create a python module for accessing features specific to Android
- handle sleep/wakeup properly
Tested Devices
--------------
These Android devices have been confirmed working with Kivy. If your
These Android devices have been confirmed to work with Kivy. If your
device is not on the list, that does not mean that it is not supported.
If that is the case, please try running Kivy and if it succeeds let us
If that is the case, please try running Kivy and if it succeeds, let us
know so that we can update this list. Note, however, that your device has
to support at least OpenGL 2.0 ES.
@ -68,7 +73,8 @@ Phones
- Xperia 10 (custom ROM 2.1 + GLES 2.0 support)
- LG Optimus S
- LG Optimus V
- Samsung Galaxy S (mostly works, seems to have some weird OpenGL behaviour, most notably kivy splash screen doesn't work)
- Samsung Galaxy S (mostly works, seems to have some weird OpenGL behaviour, most notably the kivy splash screen doesn't work)
- Samsung Galaxy Note GT-N7000
Tablets
~~~~~~~