Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mac-cain13 committed Dec 7, 2015
1 parent cc1ad5f commit 02653a5
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
6 changes: 1 addition & 5 deletions Documentation/QandA.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are many nice R.swift alternatives like [Shark](https://github.com/kaanded

## What are the requirements to run R.swift?

Recommended is the latest stable version of OS X, Xcode with the app targeting iOS 8 or higher. But OS X 10.10 with Xcode 7 while targeting iOS 7 or higher should work. R.swift should also always be runned within the Xcode build process since it needs some of the environment variables. Otherwise it could throw errors at you.
R.swift works with OS X 10.11 with Xcode 7.0 while targeting iOS 8.0 or higher. It's also recommended to run R.swift from within the Xcode build so it can use the available environment variables. Otherwise you have to provide them yourself with the available commandline flags.

## How does R.swift work?

Expand All @@ -24,7 +24,3 @@ During installation you add R.swift as a Build phase to your target, basically t
- It takes a look at your Xcode project file and inspects all resources linked with the target currently build
- It generates a `R.generated.swift` file that contains a struct with types references to all resources

## Does R.swift work for iOS7?

R.swift does also work for iOS7, with one caveat though:
- Images can only be loaded from the main bundle
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ Runtime validation with [`R.validate()`](Documentation/Examples.md#storyboards):
- [Why should I choose R.swift over alternative X or Y?](Documentation/QandA.md#why-should-i-choose-rswift-over-alternative-x-or-y)
- [How does R.swift work?](Documentation/QandA.md#how-does-rswift-work)
- [Why was R.swift created?](Documentation/QandA.md#why-was-rswift-created)
- [Does R.swift work for iOS7?](Documentation/QandA.md#does_rswift_work_for_ios7)

## Installation

Expand All @@ -77,6 +76,7 @@ _Tip:_ Add the `*.generated.swift` pattern to your `.gitignore` file to prevent

### Manually

0. Add the [R.swift.Library](https://github.com/mac-cain13/R.swift.Library) to your project
1. [Download](https://github.com/mac-cain13/R.swift/releases) a R.swift release, unzip it and put it into your source root directory
2. In XCode: Click on your project in the file list, choose your target under `TARGETS`, click the `Build Phases` tab and add a `New Run Script Phase` by clicking the little plus icon in the top left
3. Drag the new `Run Script` phase **above** the `Compile Sources` phase, expand it and paste the following script: `"$SRCROOT/rswift" "$SRCROOT"`
Expand Down

0 comments on commit 02653a5

Please sign in to comment.