summaryrefslogtreecommitdiff
path: root/README.md
blob: 1eb442bf09f4704fedd6968f42d7590cc58691b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Sia app

## Build instructions

The app can be run in debug mode allowing a hot-reload.

```
flutter run
```

A release version can be built for all the targets individually.

```
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]
- [Google icons][2]

[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