fastlane 2.89.0.beta.20180330050046 → 2.89.0.beta.20180331050023
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/fastlane/lib/fastlane/actions/docs/frame_screenshots.md +90 -28
- data/fastlane/lib/fastlane/version.rb +1 -1
- metadata +15 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d60a7e60a501e4c8c590be26c5fcecf592629182
|
|
4
|
+
data.tar.gz: 203bc77401bc24640385a23f64d9c7526f7b3a64
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2ca9862f29839cd888f327c8980bbe10ef23aa0d70b1689875d24dbb6545b07d12b23761966cfaccccd738297c8b7a39eac21dd07d3cc276f0d066e082b93c61
|
|
7
|
+
data.tar.gz: 84f8b0e3f63aeeef1238b95a4417bb807b463fc6b7a3ca3780603636b1e81e41fbffa5bb70d51d8ac34139cfaf627df7a20a8a95b3b407b7e7437e7d4019ff0a
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
<img src="/img/actions/frameit.png" width="250">
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
######
|
|
5
|
+
###### Easily put your screenshots into the right device frames
|
|
6
6
|
|
|
7
7
|
_frameit_ allows you to put a gorgeous device frame around your iOS and macOS screenshots just by running one simple command. Use _frameit_ to prepare perfect screenshots for the App Store, your website, QA or emails.
|
|
8
8
|
|
|
@@ -21,11 +21,13 @@ _frameit_ allows you to put a gorgeous device frame around your iOS and macOS sc
|
|
|
21
21
|
|
|
22
22
|
# Features
|
|
23
23
|
|
|
24
|
+
## Frame screenshot
|
|
25
|
+
|
|
24
26
|
Put a gorgeous device frame around your iOS and macOS screenshots just by running one simple command. Support for:
|
|
25
27
|
|
|
26
28
|
- iPhone, iPad and Mac
|
|
27
29
|
- Portrait and Landscape modes
|
|
28
|
-
- Several colors
|
|
30
|
+
- Several device frame colors
|
|
29
31
|
|
|
30
32
|
The complete and updated list of supported devices and colors can be found [here](https://github.com/fastlane/frameit-frames/tree/gh-pages/latest)
|
|
31
33
|
|
|
@@ -33,7 +35,16 @@ Here is a nice gif, that shows _frameit_ in action:
|
|
|
33
35
|
|
|
34
36
|
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
## Advanced Features
|
|
39
|
+
|
|
40
|
+
- Put framed screenshot on colored background, define padding
|
|
41
|
+
- add text above or under framed screenshot
|
|
42
|
+
- keyword + text
|
|
43
|
+
- choose text font and color
|
|
44
|
+
- multi line text
|
|
45
|
+
- "intelligent" positioning of text that always looks good(ish)
|
|
46
|
+
|
|
47
|
+
## Results
|
|
37
48
|
|
|
38
49
|
|
|
39
50
|
|
|
@@ -54,6 +65,8 @@ More information about this process and how to update the frames can be found [h
|
|
|
54
65
|
|
|
55
66
|
# Usage
|
|
56
67
|
|
|
68
|
+
## Basic Usage
|
|
69
|
+
|
|
57
70
|
Why should you have to use Photoshop, just to add a frame around your screenshots?
|
|
58
71
|
|
|
59
72
|
Just navigate to your folder of screenshots and use the following command:
|
|
@@ -70,16 +83,69 @@ To download the latest frames
|
|
|
70
83
|
|
|
71
84
|
When using _frameit_ without titles on top, the screenshots will have the full resolution, which means they can't be uploaded to the App Store directly. They are supposed to be used for websites, print media and emails. Check out the section below to use the screenshots for the App Store.
|
|
72
85
|
|
|
73
|
-
|
|
86
|
+
## Advanced Usage (optional)
|
|
87
|
+
|
|
88
|
+
### Text and Background
|
|
74
89
|
|
|
75
|
-
With _frameit_
|
|
90
|
+
With _frameit_ it's possible to add a custom background and text below or above the framed screenshots in fonts and colors you define.
|
|
76
91
|
|
|
77
92
|
A working example can be found in the [fastlane examples](https://github.com/fastlane/examples/tree/master/MindNode/screenshots) project.
|
|
78
93
|
|
|
79
|
-
|
|
94
|
+
### `Framefile.json`
|
|
95
|
+
|
|
96
|
+
The Framefile allows to define general and screenshot specific information.
|
|
97
|
+
It has the following JSON structure:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"device_frame_version": "latest",
|
|
102
|
+
"default": {
|
|
103
|
+
...
|
|
104
|
+
},
|
|
105
|
+
"data": [
|
|
106
|
+
...
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### General parameters
|
|
80
112
|
|
|
81
|
-
|
|
113
|
+
The general parameters are defined in the `default` key and can be:
|
|
82
114
|
|
|
115
|
+
| Key | Description | Default value |
|
|
116
|
+
|-----|-------------|---------------|
|
|
117
|
+
| `background` | The background that should be used for the framed screenshot. Specify the (relative) path to the image file (e.g. *.jpg). This parameter is mandatory. | NA |
|
|
118
|
+
| `keyword` | An object that contains up to 3 keys to describe the optional keyword. See [table](#keyword-and-title-parameters) below. | NA |
|
|
119
|
+
| `title` | An object that contains up to 3 keys to describe the mandatory title. See [table](#keyword-and-title-parameters) below. | NA |
|
|
120
|
+
| `stack_title` | Specifies whether _frameit_ should display the keyword above the title when both keyword and title are defined. If it is false, the title and keyword will be displayed side by side when both keyword and title are defined. | `false` |
|
|
121
|
+
| `title_below_image` | Specifies whether _frameit_ should place the title and optional keyword below the device frame. If it is false, it will be placed above the device frame. | `false` |
|
|
122
|
+
| `show_complete_frame` | Specifies whether _frameit_ should shrink the device frame so that it is completely shown in the framed screenshot. If it is false, clipping of the device frame might occur at the bottom (when `title_below_image` is `false`) or top (when `title_below_image` is `true`) of the framed screenshot. | `false` |
|
|
123
|
+
| `padding` | The content of the framed screenshot will be resized to match the specified `padding` around all edges. The vertical padding is also applied between the text and the top or bottom (depending on `title_below_image`) of the device frame. <P> There are 3 different options of specyfying the padding: <P> 1. Default: An integer value that defines both horizontal and vertical padding in pixels. <BR> 2. A string that defines (different) padding values in pixels for horizontal and vertical padding. The syntax is `"<horizontal>x<vertical>"`, e.g. `"30x60"`. <BR> 3. A string that defines (different) padding values in percentage for horizontal and vertical padding. The syntax is `"<horizontal>%x<vertical>%"`, e.g. `"5%x10%"`. <BR> **Note:** The percentage is calculated from the smallest image dimension (height or width). <P> A combination of option 2 and 3 is possible, e.g. `"5%x40"`. | `50` |
|
|
124
|
+
| `interline_spacing` | Specifies whether _frameit_ should add or subtract this many pixels between the individual lines of text. This only applies to a multi-line `title` and/or `keyword` to expand or squash together the individual lines of text. | `0` |
|
|
125
|
+
| `font_scale_factor` | Specifies whether _frameit_ should increase or decrease the font size of the text. | `0.1` |
|
|
126
|
+
|
|
127
|
+
### Specific parameters
|
|
128
|
+
|
|
129
|
+
The screenshot specific parameters are related to the keyword and title texts.
|
|
130
|
+
These are defined in the `data` key. This is an array with the following keys for each screenshot:
|
|
131
|
+
|
|
132
|
+
| Key | Description |
|
|
133
|
+
|-----|-------------|
|
|
134
|
+
| `filter` | This is mandatory to link the individual configuration to the screenshot, based on part of the file name. <P>Example:<BR>If a screenshot is named `iPhone 8-Brainstorming.png` you can use value `Brainstorming` for `filter`. All other keys from that array element will only be applied on this specific screenshot. |
|
|
135
|
+
| `keyword` | Similar use as in `default`, except that parameter `text` can be used here because it is screenshot specific. |
|
|
136
|
+
| `title` | Similar use as in `default`, except that parameter `text` can be used here because it is screenshot specific. |
|
|
137
|
+
|
|
138
|
+
### <a name="keyword-and-title-parameters"></a>Framefile `keyword` and `title` parameters
|
|
139
|
+
|
|
140
|
+
The `keyword` and `title` parameters are both used in `default` and `data`. They both consist of the following optional keys:
|
|
141
|
+
|
|
142
|
+
| Key | Description | Default value |
|
|
143
|
+
|-----|-------------|---------------|
|
|
144
|
+
| `color` | The font color for the text. Specify a hex/html color code. | `#000000` (black) |
|
|
145
|
+
| `font` | The font family for the text. Specify the (relative) path to the font file (e.g. an OpenType Font). | The default `imagemagick` font, which is system dependent. |
|
|
146
|
+
| `text` | The text that should be used for the `keyword` or `title`. <P> Note: If you want to use localised text, use [`.strings` files](#strings-files). | NA |
|
|
147
|
+
|
|
148
|
+
### Example
|
|
83
149
|
```json
|
|
84
150
|
{
|
|
85
151
|
"device_frame_version": "latest",
|
|
@@ -126,41 +192,31 @@ Use it to define the general information:
|
|
|
126
192
|
]
|
|
127
193
|
}
|
|
128
194
|
```
|
|
129
|
-
The `stack_title` value specifies whether _frameit_ should display the keyword above the title when both keyword and title are defined.
|
|
130
|
-
|
|
131
|
-
The `show_complete_frame` value specifies whether _frameit_ should shrink the device and frame so that they show in full in the framed screenshot. If it is false, then they can hang over the bottom of the screenshot.
|
|
132
|
-
|
|
133
|
-
The `title_below_image` value specifies whether _frameit_ should place the title below the screenshot. If it is false, it will be placed above the screenshot.
|
|
134
|
-
|
|
135
|
-
The `filter` value is a part of the screenshot named for which the given option should be used. If a screenshot is named `iPhone5_Brainstorming.png` the first entry in the `data` array will be used.
|
|
136
195
|
|
|
137
196
|
You can find a more complex [configuration](https://github.com/fastlane/examples/blob/master/MindNode/screenshots/Framefile.json) to also support Chinese, Japanese and Korean languages.
|
|
138
197
|
|
|
139
198
|
The `Framefile.json` should be in the `screenshots` folder, as seen in the [example](https://github.com/fastlane/examples/tree/master/MindNode/screenshots).
|
|
140
199
|
|
|
141
|
-
|
|
200
|
+
### `.strings` files
|
|
142
201
|
|
|
143
202
|
To define the title and optionally the keyword, put two `.strings` files into the language folder (e.g. [en-US in the example project](https://github.com/fastlane/examples/tree/master/MindNode/screenshots/en-US))
|
|
144
203
|
|
|
145
204
|
The `keyword.strings` and `title.strings` are standard `.strings` file you already use for your iOS apps, making it easy to use your existing translation service to get localized titles.
|
|
146
205
|
|
|
147
|
-
**
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
#### Uploading screenshots to iTC
|
|
152
|
-
|
|
153
|
-
Use [_deliver_](https://docs.fastlane.tools/actions/deliver/) to upload all screenshots to iTunes Connect completely automatically 🚀
|
|
206
|
+
**Notes**
|
|
207
|
+
- These `.strings` files **MUST** be utf-16 encoded (UTF-16 BE with BOM). They also must begin with an empty line. If you are having trouble see [issue #1740](https://github.com/fastlane/fastlane/issues/1740)
|
|
208
|
+
- You **MUST** provide a background if you want titles. _frameit_ will not add the tiles if a background is not specified.
|
|
154
209
|
|
|
155
|
-
|
|
210
|
+
# Mac
|
|
156
211
|
|
|
157
|
-
With _frameit_
|
|
212
|
+
With _frameit_ it's possible to also frame macOS Application screenshots. You have to provide the following:
|
|
158
213
|
|
|
159
|
-
-
|
|
160
|
-
-
|
|
161
|
-
- `
|
|
214
|
+
- A (relative) path to a `background` image file, which should contain both the background and the Mac.
|
|
215
|
+
- The `offset` information so _frameit_ knows where to position your screenshot on the `background`:
|
|
216
|
+
- `offset` : A string that specifies the horizontal and vertical offset in pixels, with respect to the top left corner of the `background` image. The syntax is `"+<horizontal>+<vertical>"`, e.g. `"+200+150"`.
|
|
217
|
+
- `titleHeight` : The height in pixels that should be used for the title.
|
|
162
218
|
|
|
163
|
-
|
|
219
|
+
## Example
|
|
164
220
|
```json
|
|
165
221
|
{
|
|
166
222
|
"default": {
|
|
@@ -189,8 +245,13 @@ Check out the [MindNode example project](https://github.com/fastlane/examples/tr
|
|
|
189
245
|
# Tips
|
|
190
246
|
|
|
191
247
|
## Generate localized screenshots
|
|
248
|
+
|
|
192
249
|
Check out [_snapshot_](https://docs.fastlane.tools/actions/snapshot/) to automatically generate screenshots using ```UI Automation```.
|
|
193
250
|
|
|
251
|
+
## Upload screenshots
|
|
252
|
+
|
|
253
|
+
Use [deliver](https://docs.fastlane.tools/actions/deliver/) to upload iOS screenshots to iTunes Connect, or [supply](https://docs.fastlane.tools/actions/supply/) to upload Android screenshots to Play Store completely automatically 🚀
|
|
254
|
+
|
|
194
255
|
## Alternative location to store device_frames
|
|
195
256
|
|
|
196
257
|
Device frames can also be stored in a ```./fastlane/screenshots/devices_frames``` directory if you prefer rather than in the ```~/.frameit/device_frames``` directory. If doing so please be aware that Apple's images are copyrighted and should not be redistributed as part of a repository so you may want to include them in your .gitignore file.
|
|
@@ -200,6 +261,7 @@ Device frames can also be stored in a ```./fastlane/screenshots/devices_frames``
|
|
|
200
261
|
Some stock images provided by Apple still have a white background instead of a transparent one. You'll have to edit the Photoshop file to remove the white background, delete the generated `.png` file and run `fastlane frameit` again.
|
|
201
262
|
|
|
202
263
|
## Use a clean status bar
|
|
264
|
+
|
|
203
265
|
You can use [SimulatorStatusMagic](https://github.com/shinydevelopment/SimulatorStatusMagic) to clean up the status bar.
|
|
204
266
|
|
|
205
267
|
## Gray artifacts around text
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
module Fastlane
|
|
2
|
-
VERSION = '2.89.0.beta.
|
|
2
|
+
VERSION = '2.89.0.beta.20180331050023'.freeze
|
|
3
3
|
DESCRIPTION = "The easiest way to automate beta deployments and releases for your iOS and Android apps".freeze
|
|
4
4
|
MINIMUM_XCODE_RELEASE = "7.0".freeze
|
|
5
5
|
RUBOCOP_REQUIREMENT = '0.49.1'.freeze
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: fastlane
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.89.0.beta.
|
|
4
|
+
version: 2.89.0.beta.20180331050023
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Kohki Miki
|
|
@@ -27,7 +27,7 @@ authors:
|
|
|
27
27
|
autorequire:
|
|
28
28
|
bindir: bin
|
|
29
29
|
cert_chain: []
|
|
30
|
-
date: 2018-03-
|
|
30
|
+
date: 2018-03-31 00:00:00.000000000 Z
|
|
31
31
|
dependencies:
|
|
32
32
|
- !ruby/object:Gem::Dependency
|
|
33
33
|
name: slack-notifier
|
|
@@ -1622,24 +1622,24 @@ metadata:
|
|
|
1622
1622
|
post_install_message:
|
|
1623
1623
|
rdoc_options: []
|
|
1624
1624
|
require_paths:
|
|
1625
|
-
- pem/lib
|
|
1626
|
-
- sigh/lib
|
|
1627
|
-
- fastlane/lib
|
|
1628
|
-
- fastlane_core/lib
|
|
1629
|
-
- spaceship/lib
|
|
1630
|
-
- produce/lib
|
|
1631
|
-
- pilot/lib
|
|
1632
|
-
- scan/lib
|
|
1633
1625
|
- gym/lib
|
|
1634
|
-
- deliver/lib
|
|
1635
|
-
- screengrab/lib
|
|
1636
|
-
- match/lib
|
|
1637
1626
|
- cert/lib
|
|
1638
1627
|
- precheck/lib
|
|
1639
|
-
-
|
|
1628
|
+
- produce/lib
|
|
1629
|
+
- spaceship/lib
|
|
1630
|
+
- scan/lib
|
|
1631
|
+
- match/lib
|
|
1640
1632
|
- snapshot/lib
|
|
1641
|
-
- frameit/lib
|
|
1642
1633
|
- supply/lib
|
|
1634
|
+
- fastlane/lib
|
|
1635
|
+
- screengrab/lib
|
|
1636
|
+
- deliver/lib
|
|
1637
|
+
- pilot/lib
|
|
1638
|
+
- credentials_manager/lib
|
|
1639
|
+
- sigh/lib
|
|
1640
|
+
- fastlane_core/lib
|
|
1641
|
+
- frameit/lib
|
|
1642
|
+
- pem/lib
|
|
1643
1643
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
1644
1644
|
requirements:
|
|
1645
1645
|
- - ">="
|