Skip to content

Commit d712647

Browse files
committed
Update Read me file to describe how to use V2.1
1 parent b885f0a commit d712647

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

README.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
Swift Weather
22
============
33

4-
SwiftWeather is an iOS weather app developed in Swift language. The app can support iPhone 4(s), iPhone 5(s), iPhone 6 and iPhone 6 Plus. The app also support Today Widgets.
4+
SwiftWeather is an iOS weather app developed in Swift language. The app can support iPhone 4(s), iPhone 5(s), iPhone 6 and iPhone 6 Plus. The app also supports Today Widgets.
55

66
## Notices
7-
The current version is working with Xcode Version 6.3 (6D570) and Version 6.3.1 (6D1002), I have been updating the app to support the lastest version of Xcode, if you have any issue, please check the Xcode version. If there is still a problem with the supported versions, please raise an issue, thanks.
7+
The current version is working with Xcode Version 6.4 (6E35b). If you have any issue, please check the Xcode version. If there is still a problem with the supported versions, please raise an issue, thanks.
88

9-
## Version 2
10-
This is version 2. I have ugraded the entire project to use [Carthage](https://github.com/Carthage/Carthage), [Alamofire](https://github.com/Alamofire/Alamofire) and [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON). And the app can only support iOS8+, if you want to support iOS7 or use CocoaPods and AFNetworking. Please have a look at [README.v1.md](https://github.com/JakeLin/SwiftWeather/blob/master/README.v1.md) and Release [Using Cocoapods and AFNetworking](https://github.com/JakeLin/SwiftWeather/releases/tag/V1). Happy coding.
9+
## Version 2.1
10+
This is version 2.1. I have remove Carthage because some developers don't have a paid Apple iOS developer account and they have issues to build Carthage packages.
11+
12+
There are two major version for the app released before.
13+
14+
* V1.0 - Support iOS 7+ using CocoaPods and AFNetworking. [README.v1.md](https://github.com/JakeLin/SwiftWeather/blob/master/README.v1.md) and [Release V1 - Using Cocoapods and AFNetworking](https://github.com/JakeLin/SwiftWeather/releases/tag/V1)
15+
* V2.0 - Support iOS 8+ using Carthage, Alamofire and SwiftyJSON. [README.v2.md](https://github.com/JakeLin/SwiftWeather/blob/master/README.v2.md) and [Release V2.0](https://github.com/JakeLin/SwiftWeather/releases/tag/v2.0)
16+
17+
V2.1 will be the last version support iOS 8. I am working on Xcode 7 to support iOS 9 only features like `UIStackView`. Happy coding.
1118

1219
## Screenshots
1320
![Loading](https://raw.githubusercontent.com/JakeLin/SwiftWeather/master/screenshots/loading-33.png)
@@ -19,26 +26,39 @@ This is version 2. I have ugraded the entire project to use [Carthage](https://g
1926

2027
## Used features
2128
* Swift Programming Language
22-
* [Carthage](https://github.com/Carthage/Carthage)
2329
* [Alamofire](https://github.com/Alamofire/Alamofire)
2430
* [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)
2531
* Core Location
2632
* Using Framework to share code between targets(app and widget).
2733

2834

29-
## Known issues
30-
Because we are using [Carthage](https://github.com/Carthage/Carthage) to build the third party packages. There are some build warings like `ld: warning: linking against dylib not safe for use in application extensions: /Build/Products/Debug-iphoneos/Alamofire.framework/Alamofire`
31-
3235
## How to build
33-
Because the app uses carthage, we need to install carthage. To install the carthage tool on your system, please download and run the Carthage.pkg file for the latest [release](https://github.com/Carthage/Carthage/releases), then follow the on-screen instructions..
34-
35-
1. Open Terminal app.
36-
2. Change directory to the project folder. `cd $project_dir`
37-
3. Use `ls` to list all the file to check whether *Cartfile* file is in the folder?
38-
4. If the *Cartfile* has been found, then execute `carthage update`.This will fetch dependencies into a Carthage/Checkouts folder, then build each one.
39-
5. On your application targets’ “General” settings tab, in the “Linked Frameworks and Libraries” section, drag and drop each framework you want to use from the Carthage/Build folder on disk. In our project, which are `Alamofire` and `SwiftyJSON`
40-
7. Press *Cmd + B* to build the app.
41-
8. Press *Cmd + R* to run the app on Simulator.
36+
37+
1) Download the repository
38+
39+
```
40+
$ git clone https://github.com/JakeLin/SwiftWeather.git
41+
$ cd SwiftWeather
42+
```
43+
44+
2) Initialize submodule dependancies
45+
46+
```
47+
$ git submodule update --init --recursive
48+
```
49+
50+
3) Open the project in Xcode
51+
52+
```
53+
$ open "Swift Weather.xcodeproj"
54+
```
55+
56+
4) Compile and run the app in your simulator
57+
58+
# Requirements
59+
60+
- Xcode 6.4
61+
- iOS 8
4262

4363
## Credits
4464
* Thanks to [johnsonjake](https://github.com/johnsonjake) for adding iOS 8 support and improving the UI/UX.

0 commit comments

Comments
 (0)