Skip to content

Commit e407c6a

Browse files
added README for Xcode asset project
1 parent 14e8b1e commit e407c6a

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

util/ios_asset_project/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Icons, Launch Storyboards and the Assets Catalog
2+
3+
Our friends from _distriqt_ have written [extensive documentation][1] on how to add an icon (in numerous variants), as well as a launch screen, for deployment to iOS.
4+
This folder contains an Xcode project that you can use to customize and export the required files.
5+
6+
* After making the modifications (as described in the above link), build the project with Xcode.
7+
* Then, right-click on "iOS Asset Project.app" (in the project navigator on the left) and select 'Show in Finder'.
8+
* In the Finder, click on the app file again and choose 'Show Package Contents'.
9+
* Copy the files `Assets.car` and `LaunchScreen.storyboardc` (optional) to the Starling Scaffold (`system` subfolder) or your own AIR project.
10+
11+
[1]: https://docs.airnativeextensions.com/docs/tutorials/ios-icons-assets-car
12+
13+
### Launch Screen storyboard vs. Harman 'Free Tier'
14+
15+
On the "Free Tier" of AIR, you're required to show a splash screen with the AIR logo.
16+
The AIR SDK handles this via its own "launch screen" storyboard.
17+
It will replace any custom one you've made (like the one in this Xcode project).
18+
19+
However, if you supply an `Assets.car` file (and you will, because it contains the app icon), you need to provide the splash image assets, as well.
20+
They're found in the AIR SDK (`lib/aot/res` folder), but I've also included them in the Xcode project.
21+
22+
So, in the free tier:
23+
24+
* Make sure the `Assets.car` file contains the AIR splash images.
25+
* Don't bother to customize and export the launch screen storyboard, as will be ignored by AIR.
26+
27+
If you're in a commercial tier:
28+
29+
* You can remove `splash_landscape` and `splash_portrait` from `Assets.xcassets` (by deleting them from the Xcode project).
30+
* Customize the launch screen storyboard, e.g. with your own logo and colors.
31+
* Include `LaunchScreen.storyboardc` when you copy over your assets from the compiled app.

0 commit comments

Comments
 (0)