lib/ios: document how to set an app icon
[nit.git] / lib / ios / README.md
1 iOS support for _app.nit_
2
3 # System configuration
4
5 Configure your system for OS X by installing Xcode and brew.
6 Follow the instructions in `README.md` at the root of the repository.
7
8 Optionally, install ios-sim to run compiled apps in the simulator: `brew install ios-sim`
9
10 # Compile and run a simple application
11
12 Let's use the `hello_ios` example in the folder `lib/ios/examples/`.
13
14 Compile with: `nitc hello_world.nit`
15
16 Run in the simulator with: `ios-sim hello_world.app`
17
18 # Sample portable applications
19
20 See the calculator example at `examples/calculator` and the Tnitter client at `contrib/tnitter/`
21 for portable applications working on GNU/Linux, OS X, iOS and Android.
22
23 # Application icon
24
25 To associate icons to your application, create the directory `ios/AppIcon.appiconset` and fill it with standard icons and `Contents.json`.
26 These files can be generated in a number of different ways:
27
28 * Using the tool `svg_to_icons` packaged with the Nit repository at `contrib/inkscape_tools/bin/svg_to_icons`.
29
30 * Using Xcode to assign images to each slot, create the folder and the file `Contents.json`.
31
32 * Write or modify the file `Contents.json` manually.
33         It is in Json format and easily readable.