X-Git-Url: http://nitlanguage.org diff --git a/lib/app/README.md b/lib/app/README.md index 8847e5d..d69a030 100644 --- a/lib/app/README.md +++ b/lib/app/README.md @@ -150,9 +150,20 @@ The _app.nit_ framework defines three annotations to customize the application p The special function `git_revision` will use the prefix of the hash of the latest git commit. By default, the version is 0.1. +* `app_files` tells the compiler where to find platform specific resource files associated to a module. + By default, only the root of the project is searched for the folders `android` and `ios`. + The `android` folder is used as base for the generated Android project, + it can be used to specify the resource files, libs and even Java source files. + The `ios` folder is searched for icons only. + + Each argument of `app_files` is a relative path to a folder containing extra `android` or `ios` folders. + If there is no arguments, the parent folder of the annotated module is used. + In case of name conflicts in the resource files, the files from the project root have the lowest priority, + those associated to modules lower in the importation hierarchy have higher priority. + ## Usage Example -~~~ +~~~nitish module my_module is app_name "My App" app_namespace "org.example.my_app" @@ -172,7 +183,7 @@ There is two main ways to achieve this goal: * The mixin option (`-m module`) imports an additional module before compiling. It can be used to load platform specific implementations of the _app.nit_ portable UI. - ~~~ + ~~~raw # GNU/Linux version, using GTK nitc calculator.nit -m linux @@ -187,7 +198,7 @@ There is two main ways to achieve this goal: Continuing with the calculator example, it is adapted for Android by the module `android_calculator.nit`. This module imports both `calculator` and `android`, it can then use Android specific code. - ~~~ + ~~~nitish module android_calculator import calculator