blob: c1e0ab06b0ece8e6d72c349a1f9814e6e4bd30d1 (
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# Mullvad VPN iOS app
This is the iOS version of the Mullvad VPN app. The app can be found on the Apple [App Store].
All releases have signed git tags on the format `ios/<version>`. For changes between each
release, see the [changelog].
For Xcode project configuration please refer to [Configure Xcode project] section of build
instructions document.
[App Store]: https://apps.apple.com/us/app/mullvad-vpn/id1488466513
[changelog]: CHANGELOG.md
[Configure Xcode project]: BuildInstructions.md#configure-xcode-project
## Code formatting
The codebase is formatted using [SwiftFormat](https://github.com/nicklockwood/SwiftFormat). Please
format all contributions using the latest version of formatter.
```
swiftformat ios/
```
Install the latest version of SwiftFormat via Homebrew:
```
brew install swiftformat
```
CI uses the latest version available on Homebrew to check formatting, so please keep your local
installation up to date, if you see it complain:
```
brew upgrade swiftformat
```
## Screenshots for AppStore
The process of taking AppStore screenshots is automated using a UI Testing bundle and Snapshot tool,
a part of Fastlane tools.
### Configuration
The screenshot script uses the real account number to log in, which is provided via Xcode build
configuration.
1. Create the build configuration using a template file:
```
cp ios/Configurations/Screenshots.xcconfig.template ios/Configurations/Screenshots.xcconfig
```
1. Edit the configuration file and put your account number without quotes:
```
vim ios/Configurations/Screenshots.xcconfig
```
### Prerequisitives
1. Make sure you have [rvm](https://rvm.io) installed.
1. Install Ruby 2.5.1 or later using `rvm install <VERSION>`.
1. Install necessary third-party ruby gems:
```
cd ios
bundle install
```
### Take screenshots
Run the following command to take screenshots:
```
cd ios
bundle exec fastlane snapshot
```
Once done all screenshots should be saved under `ios/Screenshots` folder.
### Localizations
#### Update localizations from source
Run the following command in terminal:
```
python3 update_localizations.py
```
#### Locking Python dependencies
1. Freeze dependencies:
```
pip3 freeze -r requirements.txt
```
and save the output into `requirements.txt`.
2. Hash them with `hashin` tool:
```
hashin --python 3.7 --verbose --update-all
```
## Icons and assets
For a general overview of icons and graphics read [the graphics readme](../graphics/README.md).
To copy graphical assets from the desktop GUI and generate iOS assets, run:
```bash
ios/convert-assets.rb --app-icon
ios/convert-assets.rb --import-desktop-assets
ios/convert-assets.rb --additional-assets
```
|
