Skip to content

Latest commit

 

History

History
executable file
·
145 lines (98 loc) · 4.51 KB

README.md

File metadata and controls

executable file
·
145 lines (98 loc) · 4.51 KB
Raw

YYCategories

License MIT  Carthage compatible  CocoaPods  CocoaPods  Support  Build Status

A set of useful categories for Foundation and UIKit.
(It's a component of YYKit)

Documentation

You can build and install docset use Docset scheme in Xcode, appledoc need to be pre-installed. Or your can read the Documentation online.

Installation

CocoaPods

  1. Add pod 'YYCategories' to your Podfile.
  2. Run pod install or pod update.
  3. Import <YYCategories/YYCategories.h>.

Carthage

  1. Add github "ibireme/YYCategories" to your Cartfile.
  2. Run carthage update --platform ios and add the framework to your project.
  3. Import <YYCategories/YYCategories.h>.

Manually

  1. Download all the files in the YYCategories subdirectory.
  2. Add the source files to your Xcode project.
  3. Add -fno-objc-arc compiler flag to NSObject+YYAddForARC.m and NSThread+YYAdd.m.
  4. Link with required frameworks:
    • UIKit
    • CoreGraphics
    • QuartzCore
    • Accelerate
    • ImageIO
    • CoreText
    • CoreFoundation
    • libz
  5. Import YYCategories.h.

Documentation

Full API documentation is available on CocoaDocs.
You can also install documentation locally using appledoc.

Requirements

This library requires iOS 6.0+ and Xcode 8.0+.

Notice

I want to use the APIs as if it was provided by system, so I don't add prefix in these categories. This may cause some potential problems（such as conflict with other libraries), so if you just need some pieces of code in this project, pick them out and don't import the whole library.

License

YYCategories is provided under the MIT license. See LICENSE file for details.



中文介绍

功能丰富的 Category 类型工具库。
(该项目是 YYKit 组件之一)

文档

你可以用 Docset scheme 来生成文档 (需要预先安装 appledoc)，或者在线查看。

安装

CocoaPods

  1. 在 Podfile 中添加 pod 'YYCategories'。
  2. 执行 pod install 或 pod update。
  3. 导入 <YYCategories/YYCategories.h>。

Carthage

  1. 在 Cartfile 中添加 github "ibireme/YYCategories"。
  2. 执行 carthage update --platform ios 并将生成的 framework 添加到你的工程。
  3. 导入 <YYCategories/YYCategories.h>。

手动安装

  1. 下载 YYCategories 文件夹内的所有内容。
  2. 将 YYCategories 内的源文件添加(拖放)到你的工程。
  3. 为 NSObject+YYAddForARC.m 和 NSThread+YYAdd.m 添加编译参数 -fno-objc-arc。
  4. 链接以下 frameworks:
    • UIKit
    • CoreGraphics
    • QuartzCore
    • Accelerate
    • ImageIO
    • CoreText
    • CoreFoundation
    • libz
  5. 导入 YYCategories.h。

文档

你可以在 CocoaDocs 查看在线 API 文档，也可以用 appledoc 本地生成文档。

系统要求

该项目最低支持 iOS 6.0 和 Xcode 8.0。

注意

我希望调用 API 时，有着和调用系统自带 API 一样的体验，所以我并没有为 Category 方法添加前缀。我已经用工具扫描过这个项目中的 API，确保没有对系统 API 产生影响。我知道没有前缀的 Category 可能会带来麻烦（比如可能和其他某些类库产生冲突），所以如果你只需要其中少量代码，那最好将那段代码取出来，而不是导入整个库。

许可证

YYCategories 使用 MIT 许可证，详情见 LICENSE 文件。