Skip to content

Commit

Permalink
Added orientation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcc007 committed Jul 17, 2019
1 parent 45f6f53 commit fc03804
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,30 +145,26 @@ _Screenshots_ uses a configuration file to configure a run.
The default config filename is `screenshots.yaml`:
````yaml
# A list of screen capture tests
# Note: flutter driver expects a pair of files eg, main1.dart and main1_test.dart
tests:
- test_driver/main1.dart
- test_driver/main2.dart

# Note: flutter driver expects a pair of files for testing
# For example:
# main1.dart is the test app (that calls your app)
# main1_test.dart is the matching test that flutter driver
# expects to find.

# Interim location of screenshots from tests
staging: /tmp/screenshots

# A list of locales supported by the app
locales:
- de-DE
- en-US
- de-DE

# A map of devices to emulate
devices:
ios:
iPhone XS Max:
frame: false
iPad Pro (12.9-inch) (3rd generation):
orientation: LandscapeRight
android:
Nexus 6P:

Expand All @@ -182,6 +178,8 @@ Individual devices can be configured in `screenshots.yaml` by specifying per dev
| Parameter | Values | Required | Description |
| --- | --- | --- | --- |
|frame|true/false|optional|Controls whether screenshots generated on the device should be placed in a frame. Overrides the global frame setting (see example `screenshots.yaml` above).
|orientation|Portrait \| LandscapeRight \| PortraitUpsideDown \| LandscapeLeft|optional|Controls orientation of device during test. Currently disables framing resulting in a raw screenshot. Ignored for real devices.


Note: images generated for those devices where framing is disabled are probably not suitable for upload, but can be used for local review.

Expand Down

0 comments on commit fc03804

Please sign in to comment.