diff options
| author | Oskar Nyberg <oskar@mullvad.net> | 2020-03-19 12:14:10 +0100 |
|---|---|---|
| committer | Oskar Nyberg <oskar@mullvad.net> | 2020-03-19 13:22:22 +0100 |
| commit | d307143ff3cf87bd7ca5eb8e8e95eb6deb56eaa3 (patch) | |
| tree | 22a50e853ffcec90fea07cd9fcb9ab1ac2c9a617 | |
| parent | e57fec113a113ad59acee880fe8b017cfbc5cdc9 (diff) | |
| download | mullvadvpn-d307143ff3cf87bd7ca5eb8e8e95eb6deb56eaa3.tar.xz mullvadvpn-d307143ff3cf87bd7ca5eb8e8e95eb6deb56eaa3.zip | |
Add section about icons to readme
| -rw-r--r-- | README.md | 38 |
1 files changed, 35 insertions, 3 deletions
@@ -564,11 +564,43 @@ The GUI has a specific settings file that is configured for each user. The path | Windows | `%LOCALAPPDATA%\Mullvad VPN\gui_settings.json` | | Android | Present in Android's `logcat` | -## Generating menubar icons -How to modify and generate menubar icons are described -[here](./gui/assets/images/menubar%20icons/README.md). +## Icons + +Icons such as the logo and menubar icons are automatically generated. The source files are: +| Path | Usage | +|------|-------| +| `dist-assets/icon.svg` | The logo icon used for e.g. application icon and in app logo | +| `dist-assets/icon-mono.svg` | The logo icon used for the android notification icon | +| `dist-assets/ios-icon.svg` | Logo icon used to generate the iOS application icon | +| `gui/assets/images/*.svg` | Icons used to generate iOS icons and used in the desktop app | +| `gui/assets/images/menubar icons/svg/*.svg` | The frames for the menubar icon | + +Generate desktop icon by running +```bash +gui/scripts/build-logo-icons.sh +``` + +Generate android icons +```bash +android/generate-pngs.sh +``` + +Generate iOS icon and assets +```bash +ios/convert-assets.rb --app-icon +ios/convert-assets.rb --import-desktop-assets +ios/convert-assets.rb --additional-assets +``` + +Generate desktop menubar icons +```bash +gui/scripts/build-menubar-icons.sh +``` + +The menubar icons are described futher [here](./gui/assets/images/menubar%20icons/README.md). ## Locales and translations + Instructions for how to handle locales and translations are found [here](./gui/locales/README.md). |
