README.md in snapshot-1.11.1 vs README.md in snapshot-1.12.0
- old
+ new
@@ -1,26 +1,26 @@
<h3 align="center">
- <a href="https://github.com/fastlane/fastlane">
- <img src="assets/fastlane.png" width="150" />
+ <a href="https://github.com/fastlane/fastlane/tree/master/fastlane">
+ <img src="../fastlane/assets/fastlane.png" width="150" />
<br />
fastlane
</a>
</h3>
<p align="center">
- <a href="https://github.com/fastlane/deliver">deliver</a> •
- <b>snapshot</b> •
- <a href="https://github.com/fastlane/frameit">frameit</a> •
- <a href="https://github.com/fastlane/pem">pem</a> •
- <a href="https://github.com/fastlane/sigh">sigh</a> •
- <a href="https://github.com/fastlane/produce">produce</a> •
- <a href="https://github.com/fastlane/cert">cert</a> •
- <a href="https://github.com/fastlane/spaceship">spaceship</a> •
- <a href="https://github.com/fastlane/pilot">pilot</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/deliver">deliver</a> •
+ <b>snapshot</b> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/frameit">frameit</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/pem">pem</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/sigh">sigh</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/produce">produce</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/cert">cert</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/spaceship">spaceship</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/pilot">pilot</a> •
<a href="https://github.com/fastlane/boarding">boarding</a> •
- <a href="https://github.com/fastlane/gym">gym</a> •
- <a href="https://github.com/fastlane/scan">scan</a> •
- <a href="https://github.com/fastlane/match">match</a>
+ <a href="https://github.com/fastlane/fastlane/tree/master/gym">gym</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/scan">scan</a> •
+ <a href="https://github.com/fastlane/fastlane/tree/master/match">match</a>
</p>
-------
<p align="center">
<img src="assets/snapshot.png" height="110">
@@ -28,11 +28,11 @@
snapshot
============
[](https://twitter.com/FastlaneTools)
-[](https://github.com/fastlane/snapshot/blob/master/LICENSE)
+[](https://github.com/fastlane/fastlane/blob/master/snapshot/LICENSE)
[](http://rubygems.org/gems/snapshot)
###### Automate taking localized screenshots of your iOS app on every device
You have to manually create 20 (languages) x 6 (devices) x 5 (screenshots) = **600 screenshots**.
@@ -41,11 +41,11 @@
- New screenshots with every (design) update
- No loading indicators
- Same content / screens
- [Clean Status Bar](#use-a-clean-status-bar)
-- Uploading screenshots ([`deliver`](https://github.com/fastlane/deliver) is your friend)
+- Uploading screenshots ([`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver) is your friend)
More information about [creating perfect screenshots](https://krausefx.com/blog/creating-perfect-app-store-screenshots-of-your-ios-app).
`snapshot` runs completely in the background - you can do something else, while your computer takes the screenshots for you.
@@ -55,11 +55,11 @@
Apple announced a new version of Xcode with support for UI Tests built in right into Xcode. This technology allows `snapshot` to be even better: Instead of dealing with UI Automation Javascript code, you are now be able to write the screenshot code in Swift or Objective C allowing you to use debugging features like breakpoints.
As a result, `snapshot` was completely rewritten from ground up without changing its public API.
-Please check out the [MigrationGuide to 1.0](/MigrationGuide.md) :+1:
+Please check out the [MigrationGuide to 1.0](/snapshot/MigrationGuide.md) :+1:
**Why change to UI Tests?**
- UI Automation is deprecated
- UI Tests will evolve and support even more features in the future
@@ -67,17 +67,17 @@
- UI Tests are written in Swift or Objective C
- UI Tests can be executed in a much cleaner and better way
-------
<p align="center">
- <a href="#features">Features</a> •
- <a href="#installation">Installation</a> •
- <a href="#ui-tests">UI Tests</a> •
- <a href="#quick-start">Quick Start</a> •
- <a href="#usage">Usage</a> •
- <a href="#tips">Tips</a> •
- <a href="#how-does-it-work">How?</a> •
+ <a href="#features">Features</a> •
+ <a href="#installation">Installation</a> •
+ <a href="#ui-tests">UI Tests</a> •
+ <a href="#quick-start">Quick Start</a> •
+ <a href="#usage">Usage</a> •
+ <a href="#tips">Tips</a> •
+ <a href="#how-does-it-work">How?</a> •
<a href="#need-help">Need help?</a>
</p>
-------
@@ -85,11 +85,11 @@
# Features
- Create hundreds of screenshots in multiple languages on all simulators
- Configure it once, store the configuration in git
- Do something else, while the computer takes the screenshots for you
-- Integrates with [`fastlane`](https://fastlane.tools) and [`deliver`](https://github.com/fastlane/deliver)
+- Integrates with [`fastlane`](https://fastlane.tools) and [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver)
- Generates a beautiful web page, which shows all screenshots on all devices. This is perfect to send to Q&A or the marketing team
- `snapshot` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
@@ -118,15 +118,15 @@
sudo gem install snapshot
Make sure, you have the latest version of the Xcode command line tools installed:
xcode-select --install
-
+
# UI Tests
## Getting started
-This project uses Apple's newly announced UI Tests. I will not go into detail on how to write scripts.
+This project uses Apple's newly announced UI Tests. I will not go into detail on how to write scripts.
Here a few links to get started:
- [WWDC 2015 Introduction to UI Tests](https://developer.apple.com/videos/play/wwdc2015-406/)
- [A first look into UI Tests](http://www.mokacoding.com/blog/xcode-7-ui-testing/)
@@ -139,17 +139,17 @@
# Quick Start
- Create a new UI Test target in your Xcode project ([top part of this article](https://krausefx.com/blog/run-xcode-7-ui-tests-from-the-command-line))
- Run `snapshot init` in your project folder
- Add the ./SnapshotHelper.swift to your UI Test target (You can move the file anywhere you want)
-- (Objective C only) add the bridging header to your test class.
+- (Objective C only) add the bridging header to your test class.
- `#import "MYUITests-Swift.h"`
- The bridging header is named after your test target with -Swift.h appended.
- In your UI Test class, click the `Record` button on the bottom left and record your interaction
- To take a snapshot, call the following between interactions
- Swift: `snapshot("01LoginScreen")`
- - Objective C: `[Snapshot snapshot:@"01LoginScreen" waitForLoadingIndicator:YES];`
+ - Objective C: `[Snapshot snapshot:@"01LoginScreen" waitForLoadingIndicator:YES];`
- Add the following code to your `setUp()` method
**Swift**
```swift
let app = XCUIApplication()
@@ -191,11 +191,11 @@
There are a lot of options available that define how to build your app, for example
```sh
snapshot --scheme "UITests" --configuration "Release" --sdk "iphonesimulator"
-```
+```
Reinstall the app before running `snapshot`
```sh
snapshot --reinstall_app --app_identifier "tools.fastlane.app"
@@ -266,25 +266,25 @@
```
snapshot reset_simulators
```
-**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird problems when running `snapshot`.
+**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird problems when running `snapshot`.
You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for confirmation before deleting.
## Update snapshot helpers
Some updates require the helper files to be updated. `snapshot` will automatically warn you and tell you how to update.
-Basically you can run
+Basically you can run
```
snapshot update
```
-to update your `SnapshotHelper.swift` files. In case you modified your `SnapshotHelper.swift` and want to manually update the file, check out [SnapshotHelper.swift](https://github.com/fastlane/snapshot/blob/master/lib/assets/SnapshotHelper.swift).
+to update your `SnapshotHelper.swift` files. In case you modified your `SnapshotHelper.swift` and want to manually update the file, check out [SnapshotHelper.swift](https://github.com/fastlane/fastlane/blob/master/snapshot/lib/assets/SnapshotHelper.swift).
## Launch Arguments
You can provide additional arguments to your app on launch. These strings will be available in your app (eg. not in the testing target) through `NSProcessInfo.processInfo().arguments`. Alternatively, use user-default syntax (`-key value`) and they will be available as key-value pairs in `NSUserDefaults.standardUserDefaults()`.
@@ -323,11 +323,11 @@
When you run unit tests in Xcode, the reporter generates a plist file, documenting all events that occured during the tests ([More Information](http://michele.io/test-logs-in-xcode)). Additionally, Xcode generates screenshots before, during and after each of these events. There is no way to manually trigger a screenshot event. The screenshots and the plist files are stored in the DerivedData directory, which `snapshot` stores in a temporary folder.
When the user calls `snapshot(...)` in the UI Tests (Swift or Objective C) the script actually does a rotation to `.Unknown` which doesn't have any effect on the actual app, but is enough to trigger a screenshot. It has no effect to the application and is not something you would do in your tests. The goal was to find *some* event that a user would never trigger, so that we know it's from `snapshot`.
-`snapshot` then iterates through all test events and check where we did this weird rotation. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application.
+`snapshot` then iterates through all test events and check where we did this weird rotation. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application.
In the test output, the Swift `snapshot` function will print out something like this
snapshot: [some random text here]
@@ -345,28 +345,28 @@
# Tips
## [`fastlane`](https://fastlane.tools) Toolchain
- [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow
-- [`deliver`](https://github.com/fastlane/deliver): Upload screenshots, metadata and your app to the App Store
-- [`frameit`](https://github.com/fastlane/frameit): Quickly put your screenshots into the right device frames
-- [`PEM`](https://github.com/fastlane/pem): Automatically generate and renew your push notification profiles
-- [`sigh`](https://github.com/fastlane/sigh): Because you would rather spend your time building stuff than fighting provisioning
-- [`produce`](https://github.com/fastlane/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
-- [`cert`](https://github.com/fastlane/cert): Automatically create and maintain iOS code signing certificates
-- [`spaceship`](https://github.com/fastlane/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
-- [`pilot`](https://github.com/fastlane/pilot): The best way to manage your TestFlight testers and builds from your terminal
-- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
-- [`gym`](https://github.com/fastlane/gym): Building your iOS apps has never been easier
-- [`scan`](https://github.com/fastlane/scan): The easiest way to run tests of your iOS and Mac app
-- [`match`](https://github.com/fastlane/match): Easily sync your certificates and profiles across your team using git
+- [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver): Upload screenshots, metadata and your app to the App Store
+- [`frameit`](https://github.com/fastlane/fastlane/tree/master/frameit): Quickly put your screenshots into the right device frames
+- [`PEM`](https://github.com/fastlane/fastlane/tree/master/pem): Automatically generate and renew your push notification profiles
+- [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot): The best way to manage your TestFlight testers and builds from your terminal
+- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
+- [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS apps has never been easier
+- [`scan`](https://github.com/fastlane/fastlane/tree/master/scan): The easiest way to run tests of your iOS and Mac app
+- [`match`](https://github.com/fastlane/fastlane/tree/master/match): Easily sync your certificates and profiles across your team using git
##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
## Frame the screenshots
-If you want to add frames around the screenshots and even put a title on top, check out [frameit](https://github.com/fastlane/frameit).
+If you want to add frames around the screenshots and even put a title on top, check out [frameit](https://github.com/fastlane/fastlane/tree/master/frameit).
## Available language codes
```ruby
ALL_LANGUAGES = ["da", "de-DE", "el", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi", "fr-CA", "fr-FR", "id", "it", "ja", "ko", "ms", "nl", "no", "pt-BR", "pt-PT", "ru", "sv", "th", "tr", "vi", "zh-Hans", "zh-Hant"]
```
@@ -396,10 +396,10 @@
# Need help?
Please submit an issue on GitHub and provide information about your setup
# Code of Conduct
-Help us keep `snapshot` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/code-of-conduct).
+Help us keep `snapshot` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/fastlane/blob/master/CODE_OF_CONDUCT.md).
# License
This project is licensed under the terms of the MIT license. See the LICENSE file.
> This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.