Blame view

Pods/SnapKit/README.md 3.31 KB
75d24c15   yangbin   123
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
  <img src="http://snapkit.io/images/banner.jpg" alt="" />
  
  SnapKit is a DSL to make Auto Layout easy on both iOS and OS X.
  
  [![Build Status](https://travis-ci.org/SnapKit/SnapKit.svg)](https://travis-ci.org/SnapKit/SnapKit)
  [![Platform](https://img.shields.io/cocoapods/p/SnapKit.svg?style=flat)](https://github.com/SnapKit/SnapKit)
  [![Cocoapods Compatible](https://img.shields.io/cocoapods/v/SnapKit.svg)](https://cocoapods.org/pods/SnapKit)
  [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
  
  #### ⚠️ **To use with Swift 3.x please ensure you are using >= 3.0.0** ⚠️ 
  #### ⚠️ **To use with Swift 4.x please ensure you are using >= 4.0.0** ⚠️ 
  
  ## Contents
  
  - [Requirements](#requirements)
  - [Migration Guides](#migration-guides)
  - [Communication](#communication)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Credits](#credits)
  - [License](#license)
  
  ## Requirements
  
  - iOS 8.0+ / Mac OS X 10.11+ / tvOS 9.0+
  - Xcode 9.0+
  - Swift 3.0+
  
  ## Communication
  
  - If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/snapkit). (Tag 'snapkit')
  - If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/snapkit).
  - If you **found a bug**, open an issue.
  - If you **have a feature request**, open an issue.
  - If you **want to contribute**, submit a pull request.
  
  
  ## Installation
  
  ### CocoaPods
  
  [CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
  
  ```bash
  $ gem install cocoapods
  ```
  
  > CocoaPods 1.1.0+ is required to build SnapKit 4.0.0+.
  
  To integrate SnapKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
  
  ```ruby
  source 'https://github.com/CocoaPods/Specs.git'
  platform :ios, '10.0'
  use_frameworks!
  
  target '<Your Target Name>' do
      pod 'SnapKit', '~> 4.0.0'
  end
  ```
  
  Then, run the following command:
  
  ```bash
  $ pod install
  ```
  
  ### Carthage
  
  [Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
  
  You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
  
  ```bash
  $ brew update
  $ brew install carthage
  ```
  
  To integrate SnapKit into your Xcode project using Carthage, specify it in your `Cartfile`:
  
  ```ogdl
  github "SnapKit/SnapKit" ~> 4.0.0
  ```
  
  Run `carthage update` to build the framework and drag the built `SnapKit.framework` into your Xcode project.
  
  ### Manually
  
  If you prefer not to use either of the aforementioned dependency managers, you can integrate SnapKit into your project manually.
  
  ---
  
  ## Usage
  
  ### Quick Start
  
  ```swift
  import SnapKit
  
  class MyViewController: UIViewController {
  
      lazy var box = UIView()
  
      override func viewDidLoad() {
          super.viewDidLoad()
  
          self.view.addSubview(box)
          box.snp.makeConstraints { (make) -> Void in
             make.width.height.equalTo(50)
             make.center.equalTo(self.view)
          }
      }
  
  }
  ```
  
  ### Resources
  
  - [Documentation](http://snapkit.io/docs/)
  - [F.A.Q.](http://snapkit.io/faq/)
  
  ## Credits
  
  - Robert Payne ([@robertjpayne](https://twitter.com/robertjpayne))
  - Many other contributors
  
  ## License
  
  SnapKit is released under the MIT license. See LICENSE for details.