From 51f60d49974845c33c582dc37d419a2daa72557b Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 17:57:47 -0500 Subject: [PATCH 1/6] Revisions to packaging-ios.rst --- doc/sources/guide/packaging-ios.rst | 59 +++++++++++++++-------------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index bd06791ef..a6c97ad8b 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -7,16 +7,16 @@ Create a package for IOS .. warning:: - This method is still under development. + This process is still under development. -The overall method for creating a package on IOS can be explained in 4 steps: +The overall process for creating a package for IOS can be explained in 4 steps: #. Compile python + modules for IOS #. Create an Xcode project #. Populate the Xcode project with your application source code #. Customize -The current method have been tested with Xcode 4.2 +This process have been tested with Xcode 4.2. Prerequisites ------------- @@ -37,7 +37,7 @@ Ensure that everything is ok before starting the second step! Compile the distribution ------------------------ -Open a terminal, and:: +Open a terminal, and type:: $ git clone git://github.com/kivy/kivy-ios $ cd kivy-ios @@ -53,11 +53,12 @@ Most of the python distribution will be packed into a `python27.zip`. Create an Xcode project ----------------------- -Before doing the next step, ensure your application entry point is a file named -`main.py`. +Before proceeding to the next step, ensure your application entry point is a file +named `main.py`. -We provide a script that create an initial xcode project to start with (replace -test with that you want. Must be a name without any space / weird chars):: +We provide a script that creates an initial Xcode project to start with. In the +command line below, replace `test` with your project name. It must be a +name without any spaces or illegal characters):: $ tools/create-xcode-project.sh test /path/to/your/appdir @@ -72,17 +73,17 @@ Customize You can customize the build in many ways: -#. Minimize the `build/python/lib/python27.zip`: this contain all the python - modules. You can edit the zip file, and remove all the files you'll not use +#. Minimize the `build/python/lib/python27.zip`: this contains all the python + modules. You can edit the zip file and remove all the files you'll not use (reduce encodings, remove xml, email...) #. Remove the .a not used: in Xcode, select your target, go in `Build Phases`, then check the `Link Binary With Libraries`. You can remove the libraries not used by your application. #. Change the icon, orientation, etc... According to the Apple policy :) #. Go to the settings panel > build, search for "strip" options, and - triple-check that they are all set to NO. Stripping is not working with - Python dynamic modules, and will strip needed symbols. -#. Indicate a launch image in portrait/landscape for ipad with and without + triple-check that they are all set to NO. Stripping does not work with + Python dynamic modules and will remove needed symbols. +#. Indicate a launch image in portrait/landscape for iPad with and without retina display. .. _Known issues: @@ -90,17 +91,17 @@ You can customize the build in many ways: Known issues ------------ -Currently, the project have few issues as (we'll fixes them during the -development): +Currently, the project has a few known issues (we'll fix these in future +versions): -- Application configuration not writing: we are learning how IOS manage its +- Application configuration not writing: we are still learning how IOS manages its filesystem. -- You can't export your project outside kivy-ios directory, because the +- You can't export your project outside the kivy-ios directory because the libraries included in the project are relative to it. -- Removing some libraries (like SDL_Mixer for the sound) is currently not - possible cause kivy project need it. +- Removing some libraries (like SDL_Mixer for audio) is currently not + possible because the kivy project requires it. - And more, just too technical to be written here. @@ -112,23 +113,23 @@ FAQ Application quit abnormally! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -By default, all the print on the console and files are avoided. If you have an -issue when running your application, you can activate the log by commenting the -line in the main.m:: +By default, all the print statements to the console and files are ignored. If +you have an issue when running your application, you can activate the log by +uncommenting the line in the main.m:: putenv("KIVY_NO_CONSOLELOG=1"); -Then, you should see all the Kivy log on the Xcode console. +Then you should see all the Kivy logging on the Xcode console. -How Apple can accept a python app ? +How can Apple accept a python app ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -We managed to merge the app binary with all the libraries into only one binary, -as libpython. At the end, all binaries modules are already loaded, nothing is -dynamically loaded. +We managed to merge the app binary with all the libraries into a single binary, +called libpython. This means all binary modules are loaded beforehand, so +nothing is dynamically loaded. -Did you already submit a Kivy application to the App store ? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Have you already submited a Kivy application to the App store ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Yes, check: From 0c9e25d9d7aa7f8722823886991e23eb93f5b66e Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 18:36:51 -0500 Subject: [PATCH 2/6] Spelling correction --- doc/sources/guide/packaging-ios.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index a6c97ad8b..196d23524 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -16,7 +16,7 @@ The overall process for creating a package for IOS can be explained in 4 steps: #. Populate the Xcode project with your application source code #. Customize -This process have been tested with Xcode 4.2. +This process has been tested with Xcode 4.2. Prerequisites ------------- From 14d1c0ee2b08ad1db672f61a21fa2a3b2f705862 Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 18:38:59 -0500 Subject: [PATCH 3/6] Spelling correction --- doc/sources/guide/packaging-ios.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index 196d23524..3b1e82e0a 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -58,7 +58,7 @@ named `main.py`. We provide a script that creates an initial Xcode project to start with. In the command line below, replace `test` with your project name. It must be a -name without any spaces or illegal characters):: +name without any spaces or illegal characters:: $ tools/create-xcode-project.sh test /path/to/your/appdir From ca7d99290a860dc68c46db588046e1734cc7ae75 Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 18:51:27 -0500 Subject: [PATCH 4/6] This makes more sense --- doc/sources/guide/packaging-ios.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index 3b1e82e0a..139208a2c 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -115,7 +115,7 @@ Application quit abnormally! By default, all the print statements to the console and files are ignored. If you have an issue when running your application, you can activate the log by -uncommenting the line in the main.m:: +commenting out the line in the main.m:: putenv("KIVY_NO_CONSOLELOG=1"); From 18282eabc4e6d3b3b92963d28e9c5b6531bc6b64 Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 18:53:40 -0500 Subject: [PATCH 5/6] Eish --- doc/sources/guide/packaging-ios.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index 139208a2c..a19691bb1 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -115,7 +115,7 @@ Application quit abnormally! By default, all the print statements to the console and files are ignored. If you have an issue when running your application, you can activate the log by -commenting out the line in the main.m:: +commenting out this line in the main.m:: putenv("KIVY_NO_CONSOLELOG=1"); From 1065dac854879e7985a54b7386ee3fc7378f1dfc Mon Sep 17 00:00:00 2001 From: Zen-CODE Date: Sun, 24 Mar 2013 18:55:04 -0500 Subject: [PATCH 6/6] Small tweak --- doc/sources/guide/packaging-ios.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/guide/packaging-ios.rst b/doc/sources/guide/packaging-ios.rst index a19691bb1..11e8af68e 100644 --- a/doc/sources/guide/packaging-ios.rst +++ b/doc/sources/guide/packaging-ios.rst @@ -115,7 +115,7 @@ Application quit abnormally! By default, all the print statements to the console and files are ignored. If you have an issue when running your application, you can activate the log by -commenting out this line in the main.m:: +commenting out this line in `main.m`:: putenv("KIVY_NO_CONSOLELOG=1");