add chinese README

javayhu · May 14, 2016 · c25e5d0 · c25e5d0
1 parent 43b8e66
commit c25e5d0
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 17 deletions.
diff --git a/Gank.xcodeproj/project.pbxproj b/Gank.xcodeproj/project.pbxproj
@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		A0A1EB5BEA0EA66DDCFC3B7C /* Pods_Gank.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B71DE5E34C80D7F11D29D874 /* Pods_Gank.framework */; };
+		C819FF661CE71E70004D569E /* README-EN.md in Sources */ = {isa = PBXBuildFile; fileRef = C819FF651CE71E70004D569E /* README-EN.md */; };
 		C83D57C71CE62E1B00762FF1 /* screenshot.png in Resources */ = {isa = PBXBuildFile; fileRef = C83D57C61CE62E1A00762FF1 /* screenshot.png */; };
 		C83D57C91CE62E2300762FF1 /* LICENSE.txt in Resources */ = {isa = PBXBuildFile; fileRef = C83D57C81CE62E2300762FF1 /* LICENSE.txt */; };
 		C83D57CB1CE6300400762FF1 /* screenshot2.png in Resources */ = {isa = PBXBuildFile; fileRef = C83D57CA1CE6300400762FF1 /* screenshot2.png */; };
@@ -41,6 +42,7 @@
 		4F9AAFD7867AD56F0F15DDA2 /* Pods-Gank.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Gank.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Gank/Pods-Gank.debug.xcconfig"; sourceTree = "<group>"; };
 		794D55073DB106AE6F7076E8 /* Pods-Gank.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Gank.release.xcconfig"; path = "Pods/Target Support Files/Pods-Gank/Pods-Gank.release.xcconfig"; sourceTree = "<group>"; };
 		B71DE5E34C80D7F11D29D874 /* Pods_Gank.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Gank.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		C819FF651CE71E70004D569E /* README-EN.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; name = "README-EN.md"; path = "../README-EN.md"; sourceTree = "<group>"; };
 		C83D57C01CE6259000762FF1 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; name = README.md; path = ../README.md; sourceTree = "<group>"; };
 		C83D57C61CE62E1A00762FF1 /* screenshot.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = screenshot.png; path = ../screenshot.png; sourceTree = "<group>"; };
 		C83D57C81CE62E2300762FF1 /* LICENSE.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = LICENSE.txt; path = ../LICENSE.txt; sourceTree = "<group>"; };
@@ -134,6 +136,7 @@
 				C83D57CA1CE6300400762FF1 /* screenshot2.png */,
 				C83D57C81CE62E2300762FF1 /* LICENSE.txt */,
 				C83D57C61CE62E1A00762FF1 /* screenshot.png */,
+				C819FF651CE71E70004D569E /* README-EN.md */,
 				C83D57C01CE6259000762FF1 /* README.md */,
 				C887EF7D1CE37ADD0065DA55 /* Assets.xcassets */,
 				C887EF8F1CE3831E0065DA55 /* MainMenu.xib */,
@@ -339,6 +342,7 @@
 				C8C636BE1CE5EDC300801E00 /* GankSection.swift in Sources */,
 				C887EF8A1CE37FF10065DA55 /* EventMonitor.swift in Sources */,
 				C87D6BA31CE4731B00AA31B6 /* GankItem.swift in Sources */,
+				C819FF661CE71E70004D569E /* README-EN.md in Sources */,
 				C887EF921CE384DB0065DA55 /* GankAPI.swift in Sources */,
 				C8EB099A1CE58A6A00861B77 /* GankSectionCell.swift in Sources */,
 				C8EB09991CE58A6A00861B77 /* GankScrollView.swift in Sources */,

diff --git a/README-EN.md b/README-EN.md
@@ -0,0 +1,61 @@
+
+# Gank for Mac
+
+> The missing Mac OS X application for [gank.io](https://gank.io)
+
+## Application Features
+
+This tiny application is used to view the `gank` posts in [gank.io](https://gank.io), and send you a notification when new post arrived. Nothing more and nothing less.   
+It is developed with [Swift](https://swift.org/) 2.2!!! Excited? 😜   
+Btw, please make sure your mac system is OS X 10.10 or later.
+
+![img](screenshot2.png)
+
+Almost all the code is explained with its fuctions, so enjoy reading the source code. 😄   
+Since I just learned Swift language and Mac OS X application development this week, please be nice when you read the xxxx code. 😂 Btw, other helpful features are still under development. 😘     
+Feel free to submit any pull request to make it better or send your suggestions to [me](mailto:[email protected]).
+
+![img](screenshot3.png)
+
+## Get this Application
+
+You can rebuild this project to get this applicaton or you can download Gank for Mac [here](https://github.com/hujiaweibujidao/Gank/releases)
+
+## Data and Libraries
+
+1.[gank.io](http://gank.io/) and its [API](http://gank.io/api): Share technical `ganks` every day  
+2.[Alamofire](https://github.com/Alamofire/Alamofire): Elegant HTTP Networking in Swift  
+3.[SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON): The better way to deal with JSON data in Swift  
+4.[SwiftyTimer](https://github.com/radex/SwiftyTimer): Swifty API for NSTimer  
+5.Image resources are coming from [IconFinder](https://www.iconfinder.com/), mainly from [this iconset](https://www.iconfinder.com/iconsets/picons-social) with the license of free for commercial use.
+
+## Projects Based on
+
+1.[Product Hunt](https://github.com/producthunt/producthunt-osx)  
+2.[Toutiao for Mac](https://github.com/judi0713/TouTiao)
+
+## The License
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2016 Hujiawei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
diff --git a/README.md b/README.md
@@ -1,39 +1,52 @@
 
-# Gank for Mac
+# Gank for Mac 
 
-> The missing Mac OS X application for [gank.io](https://gank.io)
+> The missing Mac OS X application for [gank.io](https://gank.io). 
 
-## Application Features
+Gank for Mac是一个小巧的干货集中营Mac端应用，它只在你的状态栏占据一点点空间而已。 
 
-This tiny application is used to view the `gank` posts in [gank.io](https://gank.io), and send you a notification when new post arrived. Nothing more and nothing less.   
-It is developed with [Swift](https://swift.org/) 2.2!!! Excited? 😜   
-Btw, please make sure your mac system is OS X 10.10 or later.
+[应用下载地址](https://github.com/hujiaweibujidao/Gank/releases)  [README in English](README-EN.md)
 
-![img](screenshot2.png)
+## 应用功能
 
-Almost all the code is explained with its fuctions, so enjoy reading the source code. 😄   
-Since I just learned Swift language and Mac OS X application development this week, please be nice when you read the xxxx code. 😂 Btw, other helpful features are still under development. 😘     
-Feel free to submit any pull request to make it better or send your suggestions to [me](mailto:[email protected]).
+Gank for Mac的功能包括查看[干货集中营](https://gank.io)今天或者以前的干货数据，同时在应用启动的情况下，当有新的干货到来的时候会推送通知给你喂食哟，麻麻为了不让你饿着真是操碎了心。当然，你再也不用担心抢不到评论区的沙发啦！😚
 
-![img](screenshot3.png)
+Gank for Mac使用的是 [Swift](https://swift.org/) 语言开发的，Mac系统版本要求10.10及以上，应用截图如下：
+
+![img](screenshot2.png)
 
-## Get this Application
+由于我是刚学Swift，而且还是第一次写Mac OS X应用，所以项目源码基本上都注释得很清楚，但是不保证代码写得非常好，所以哪块代码要是没写好请轻拍哈。当然，欢迎提交PR或者提建议。😘
 
-You can rebuild this project to get this applicaton or you can download Gank for Mac [here](https://github.com/hujiaweibujidao/Gank/releases)
+![img](screenshot3.png)
 
-## Data and Libraries
+## 数据+依赖+资源
 
-1.[gank.io](http://gank.io/) and its [API](http://gank.io/api): Share technical `ganks` every day  
+1.[gank.io](http://gank.io/) and its [API](http://gank.io/api): 每日分享妹子图和技术干货  
 2.[Alamofire](https://github.com/Alamofire/Alamofire): Elegant HTTP Networking in Swift  
 3.[SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON): The better way to deal with JSON data in Swift  
 4.[SwiftyTimer](https://github.com/radex/SwiftyTimer): Swifty API for NSTimer  
-5.Image resources are coming from [IconFinder](https://www.iconfinder.com/), mainly from [this iconset](https://www.iconfinder.com/iconsets/picons-social) with the license of free for commercial use.
+5.图片来源于[IconFinder](https://www.iconfinder.com/)，主要是[这个图标集合](https://www.iconfinder.com/iconsets/picons-social)
 
-## Projects Based on
+## 参考项目
 
 1.[Product Hunt](https://github.com/producthunt/producthunt-osx)  
 2.[Toutiao for Mac](https://github.com/judi0713/TouTiao)
 
+### FAQ
+
+#### 1.妹子图在哪里呢？
+
+我就知道你只关心妹子！！！🙈   
+为了应用的简洁(实际是我写不出来😂)，点击妹子图或者休息视频会进入那天的干货日报界面。
+
+#### 2.后台自动刷新的时间间隔设置的是多久？
+
+默认是10分钟，如果你觉得不合适可以自己改改源码重新生成一个应用哈。
+
+#### 3.为啥没有开机自启动？
+
+应用的开机自启动可以在`System Preferences`中设置的嘛，别以为我不知道！😌
+
 ## The License
 
 ```