README.md in scan-0.0.1 vs README.md in scan-0.1.0
- old
+ new
@@ -1,41 +1,203 @@
-# Scan
+<h3 align="center">
+ <a href="https://github.com/KrauseFx/fastlane">
+ <img src="assets/fastlane.png" width="150" />
+ <br />
+ fastlane
+ </a>
+</h3>
+<p align="center">
+ <a href="https://github.com/KrauseFx/deliver">deliver</a> •
+ <a href="https://github.com/KrauseFx/snapshot">snapshot</a> •
+ <a href="https://github.com/KrauseFx/frameit">frameit</a> •
+ <a href="https://github.com/KrauseFx/PEM">PEM</a> •
+ <a href="https://github.com/KrauseFx/sigh">sigh</a> •
+ <a href="https://github.com/KrauseFx/produce">produce</a> •
+ <a href="https://github.com/KrauseFx/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/boarding">boarding</a> •
+ <a href="https://github.com/fastlane/gym">gym</a> •
+ <b>scan</b>
+</p>
+-------
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scan`. To experiment with that code, run `bin/console` for an interactive prompt.
+<p align="center">
+ <img src="assets/scan.png" height="110">
+</p>
-TODO: Delete this and the text above, and describe your gem
+scan
+============
-## Installation
+[](https://twitter.com/KrauseFx)
+[](https://github.com/fastlane/scan/blob/master/LICENSE)
+[](http://rubygems.org/gems/scan)
+[](https://travis-ci.org/fastlane/scan)
-Add this line to your application's Gemfile:
+###### Building your app has never been easier
-```ruby
-gem 'scan'
+Get in contact with the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
+
+-------
+<p align="center">
+ <a href="#whats-scan">Features</a> •
+ <a href="#installation">Installation</a> •
+ <a href="#usage">Usage</a> •
+ <a href="#tips">Tips</a> •
+ <a href="#need-help">Need help?</a>
+</p>
+
+-------
+
+<h5 align="center"><code>scan</code> is part of <a href="https://fastlane.tools">fastlane</a>: connect all deployment tools into one streamlined workflow.</h5>
+
+# What's scan?
+
+`scan` makes it super easy to run tests of your iOS and Mac app. It does all the heavy lifting for you to run your tests... the easy way.
+
+### Before `scan`
+
+```sh
+xcodebuild \
+ -workspace MyApp.xcworkspace \
+ -scheme "MyApp" \
+ -sdk iphonesimulator \
+ -destination 'platform=iOS Simulator,name=iPhone 6,OS=8.1' \
+ test
```
-And then execute:
+As the output will look like this
- $ bundle
+```
+/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.o Example/main.m normal arm64 objective-c com.apple.compilers.llvm.clang.1_0.compiler
+ cd /Users/felixkrause/Developer/fastlane/gym/example/cocoapods
+ export LANG=en_US.US-ASCII
+ export PATH="/Applications/Xcode-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin:/Applications/Xcode-beta.app/Contents/Developer/usr/bin:/Users/felixkrause/.rvm/gems/ruby-2.2.0/bin:/Users/felixkrause/.rvm/gems/ruby-2.2.0@global/bin:/Users/felixkrause/.rvm/rubies/ruby-2.2.0/bin:/Users/felixkrause/.rvm/bin:/usr/local/heroku/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
+ /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -x objective-c -arch arm64 -fmessage-length=126 -fdiagnostics-show-note-include-stack -fmacro-backtrace-limit=0 -fcolor-diagnostics -std=gnu99 -fobjc-arc -fmodules -gmodules -fmodules-cache-path=/Users/felixkrause/Library/Developer/Xcode/DerivedData/ModuleCache -fmodules-prune-interval=86400 -fmodules-prune-after=345600 -fbuild-session-file=/Users/felixkrause/Library/Developer/Xcode/DerivedData/ModuleCache/Session.modulevalidation -fmodules-validate-once-per-build-session -Wnon-modular-include-in-framework-module -Werror=non-modular-include-in-framework-module -Wno-trigraphs -fpascal-strings -Os -fno-common -Wno-missing-field-initializers -Wno-missing-prototypes -Werror=return-type -Wunreachable-code -Wno-implicit-atomic-properties -Werror=deprecated-objc-isa-usage -Werror=objc-root-class -Wno-arc-repeated-use-of-weak -Wduplicate-method-match -Wno-missing-braces -Wparentheses -Wswitch -Wunused-function -Wno-unused-label -Wno-unused-parameter -Wunused-variable -Wunused-value -Wempty-body -Wconditional-uninitialized -Wno-unknown-pragmas -Wno-shadow -Wno-four-char-constants -Wno-conversion -Wconstant-conversion -Wint-conversion -Wbool-conversion -Wenum-conversion -Wshorten-64-to-32 -Wpointer-sign -Wno-newline-eof -Wno-selector -Wno-strict-selector-match -Wundeclared-selector -Wno-deprecated-implementations -DCOCOAPODS=1 -DNS_BLOCK_ASSERTIONS=1 -DOBJC_OLD_DISPATCH_PROTOTYPES=0 -isysroot /Applications/Xcode-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS9.0.sdk -fstrict-aliasing -Wprotocol -Wdeprecated-declarations -miphoneos-version-min=9.0 -g -fvisibility=hidden -Wno-sign-conversion -fembed-bitcode -iquote /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-generated-files.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-own-target-headers.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-all-target-headers.hmap -iquote /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/ExampleProductName-project-headers.hmap -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/BuildProductsPath/Release-iphoneos/include -I/Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public -I/Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public/HexColors -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/DerivedSources/arm64 -I/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/DerivedSources -F/Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/BuildProductsPath/Release-iphoneos -isystem /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public -isystem /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Pods/Headers/Public/HexColors -MMD -MT dependencies -MF /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.d --serialize-diagnostics /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.dia -c /Users/felixkrause/Developer/fastlane/gym/example/cocoapods/Example/main.m -o /Users/felixkrause/Library/Developer/Xcode/DerivedData/Example-fhlmxikmujknefgidqwqvtbatohi/Build/Intermediates/ArchiveIntermediates/Example/IntermediateBuildFilesPath/Example.build/Release-iphoneos/Example.build/Objects-normal/arm64/main.o
+```
+you'll probably want to use something like [xcpretty](https://github.com/supermarin/xcpretty), which will look like this:
-Or install it yourself as:
+```sh
+set -o pipefail &&
+ xcodebuild \
+ -workspace MyApp.xcworkspace \
+ -scheme "MyApp" \
+ -sdk iphonesimulator \
+ -destination 'platform=iOS Simulator,name=iPhone 6,OS=8.1' \
+ test \
+ | xcpretty \
+ -r "html" \
+ -o "tests.html"
+```
- $ gem install scan
+### With `scan`
-## Usage
+```
+scan
+```
-TODO: Write usage instructions here
+### Why `scan`?
-## Development
+`scan` uses the latest APIs and tools to make running tests plain simple and offer a great integration into your existing workflow, like [fastlane](https://fastlane.tools) or Jenkins.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+ | scan Features
+--------------------------|------------------------------------------------------------
+:checkered_flag: | Beautiful inline build output while running the tests
+:mountain_cableway: | Sensible defaults: Automatically detect the project, its schemes and more
+:bar_chart: | Support for HTML, JSON and JUnit reports
+:mag: | Xcode duplicated your simulators again? `scan` will handle this for you
+:link: | Works perfectly with [fastlane](https://fastlane.tools) and other tools
+:bullettrain_side: | Don't remember any complicated build commands, just `scan`
+:wrench: | Easy and dynamic configuration using parameters and environment variables
+:loudspeaker: | Beautiful slack notifications of the test results
+:floppy_disk: | Store common build settings in a `Scanfile`
+:outbox_tray: | The raw `xcodebuild` outputs are stored in `~/Library/Logs/scan`
+:computer: | Supports both iOS and Mac applications
+:man: | Automatically switches to the [travis formatter](https://github.com/kattrali/xcpretty-travis-formatter) when running on Travis
+:book: | Helps you resolve common test errors like simulator not responding
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`scan` uses a plain `xcodebuild` command, therefore keeping 100% compatible with `xcodebuild`. To generate the nice output, `scan` uses [xcpretty](https://github.com/supermarin/xcpretty). You can alway access the raw output in `~/Library/Logs/scan`.
-## Contributing
+
+
+
+
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+# Installation
+ sudo gem install scan
-## License
+Make sure, you have the latest version of the Xcode command line tools installed:
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+ xcode-select --install
+# Usage
+
+ scan
+
+That's all you need to run your tests. If you want more control, here are some available parameters:
+
+ scan --workspace "Example.xcworkspace" --scheme "AppName" --clean
+
+If you need to use a different xcode install, use xcode-select or define DEVELOPER_DIR:
+
+ DEVELOPER_DIR="/Applications/Xcode6.2.app" scan
+
+For a list of all available parameters use
+
+ scan --help
+
+To access the raw `xcodebuild` output open `~/Library/Logs/scan`
+
+# Scanfile
+
+Since you might want to manually trigger the tests but don't want to specify all the parameters every time, you can store your defaults in a so called `Scanfile`.
+
+Run `scan init` to create a new configuration file. Example:
+
+```ruby
+scheme "Example"
+
+clean true
+
+output_types "html"
+```
+
+# Automating the whole process
+
+`scan` works great together with [fastlane](https://fastlane.tools), which connects all deployment tools into one streamlined workflow.
+
+Using `fastlane` you can define a configuration like
+
+```ruby
+lane :test do
+ scan(scheme: "Example")
+end
+```
+
+For more information visit the [fastlane GitHub page](https://github.com/KrauseFx/fastlane).
+
+
+# Tips
+## [`fastlane`](https://fastlane.tools) Toolchain
+
+- [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow
+- [`deliver`](https://github.com/KrauseFx/deliver): Upload screenshots, metadata and your app to the App Store
+- [`snapshot`](https://github.com/KrauseFx/snapshot): Automate taking localized screenshots of your iOS app on every device
+- [`frameit`](https://github.com/KrauseFx/frameit): Quickly put your screenshots into the right device frames
+- [`PEM`](https://github.com/KrauseFx/pem): Automatically generate and renew your push notification profiles
+- [`produce`](https://github.com/KrauseFx/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`cert`](https://github.com/KrauseFx/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
+
+##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
+
+# Need help?
+Please submit an issue on GitHub and provide information about your setup
+
+# 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.