1
1
mirror of https://github.com/exyte/Macaw.git synced 2024-09-11 13:15:35 +03:00
Macaw/README.md

84 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2015-12-07 22:23:30 +03:00
# Macaw
[![CI Status](http://img.shields.io/travis/Igor Zapletnev/Macaw.svg?style=flat)](https://travis-ci.org/Igor Zapletnev/Macaw)
[![Version](https://img.shields.io/cocoapods/v/Macaw.svg?style=flat)](http://cocoapods.org/pods/Macaw)
[![License](https://img.shields.io/cocoapods/l/Macaw.svg?style=flat)](http://cocoapods.org/pods/Macaw)
[![Platform](https://img.shields.io/cocoapods/p/Macaw.svg?style=flat)](http://cocoapods.org/pods/Macaw)
2016-09-02 11:16:54 +03:00
2016-09-20 11:26:18 +03:00
<img src="https://github.com/exyte/Macaw/blob/master/logo.png" width="400">
2016-07-09 10:54:12 +03:00
2016-07-09 11:11:35 +03:00
## What is Macaw?
2016-09-20 12:48:19 +03:00
Macaw is a powerful and easy-to-use vector graphics library written in Swift.
2016-07-09 11:11:35 +03:00
2016-09-20 12:48:19 +03:00
#### It's simple
2016-07-09 11:11:35 +03:00
2016-09-20 12:48:19 +03:00
Get started with Macaw in several lines of code:
2015-12-07 22:23:30 +03:00
2016-09-20 12:48:19 +03:00
```swift
class MyView: MacawView {
required init?(coder aDecoder: NSCoder) {
2016-09-20 12:48:52 +03:00
let text = Text(text: "Hello, World!", place: .move(dx: 145, dy: 100))
2016-09-20 12:48:19 +03:00
super.init(node: text, coder: aDecoder)
}
}
```
2016-09-23 16:30:49 +03:00
<img src="https://www.dropbox.com/s/o4xe3eezk4zv901/macaw-readme-001.png?dl=1" width="475">
2016-09-20 12:48:19 +03:00
#### It has SVG support
Include Scalable Vector Graphics right into your application:
```swift
class SVGView: MacawView {
required init?(coder aDecoder: NSCoder) {
super.init(node: SVGParser.parse(path: "tiger"), coder: aDecoder)
}
}
```
2016-09-23 16:30:49 +03:00
<img src="https://www.dropbox.com/s/p84o7komopmb2yn/macaw-howto-004.png?dl=1" width="475">
2016-09-20 12:48:19 +03:00
#### It's powerful
Affine transformations, user events, animation and various effects to build beautiful apps with Macaw:
2016-09-23 16:30:49 +03:00
<img src="https://www.dropbox.com/s/b6lspzzqa80ielk/periodic-ipad.gif?dl=1" width="600">
2016-09-20 12:48:19 +03:00
Take a look at [getting started guide](https://github.com/exyte/Macaw/wiki/Getting-started) to learn more.
2015-12-07 22:23:30 +03:00
## Requirements
2016-07-09 11:11:35 +03:00
* iOS 8.0+ / Mac OS X 10.9+
* Xcode 7.3+
2015-12-07 22:23:30 +03:00
## Installation
2016-09-20 12:48:19 +03:00
Macaw is available through [CocoaPods](http://cocoapods.org).
To install it, simply add the following line to your Podfile:
2015-12-07 22:23:30 +03:00
```ruby
pod "Macaw"
```
2016-09-20 12:48:19 +03:00
## Building from sources
To build Macaw from sources:
* clone the repo `git@github.com:exyte/Macaw.git`
* open terminal and run `cd <MacawRepo>/Example/`
* run `pod install` to install all dependencies
* run `open Example.xcworkspace/` to open project in the Xcode
2016-07-09 11:11:35 +03:00
2015-12-07 22:23:30 +03:00
## Author
2016-07-09 10:48:56 +03:00
exyte, [info@exyte.com](mailto:info@exyte.com)
2015-12-07 22:23:30 +03:00
## License
Macaw is available under the MIT license. See the LICENSE file for more info.