diff options
| -rw-r--r-- | README.md | 39 |
1 files changed, 38 insertions, 1 deletions
@@ -1,6 +1,6 @@ # Sia app -## Usage +## Build instructions The app can be run in debug mode allowing a hot-reload. @@ -15,6 +15,41 @@ flutter build linux flutter build apk ``` +## Icon maintenance + +The Sia app icon is a vector graphic which can be edited with Inkscape [3]. + +``` +inkscape icon/main.svg +``` + +The geometry is based on the recommendations for Android Adaptive Icons [4]. + +For the tooling to work there are three objects expected in the file with the +following IDs: + +- `background` +- `safe-zone` (never display this in production) +- `foreground` + +A custom Python script generates all icon files in the `icon` subdirectory from +the primary vector graphics file. + +``` +./icon/convert.py +``` + +The Android icon files need to be copied to certain locations in the `android` +subdirectory. + +The `flutter_launcher_icons` tool exists to do this. + +``` +dart run flutter_launcher_icons +``` + +It is configured via `flutter_launcher_icons.yaml`. + ## See also - [Flutter widgets][1] @@ -22,3 +57,5 @@ flutter build apk [1]: https://docs.flutter.dev/ui/widgets [2]: https://fonts.google.com/icons +[3]: https://inkscape.org +[4]: https://developer.android.com/develop/ui/views/launch/icon_design_adaptive |