Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 3.08 KB

README.md

File metadata and controls

81 lines (53 loc) · 3.08 KB
Raw

generator-swift-framework

Scaffolds out a Xcode Embedded Framework project with Swift 2.0

Build Status js-standard-style Dependency Status devDependency Status semantic-release

generator-swift-framework is used to create a Xcode Embedded Framework project with the following features:

  • Embedded Framework template
  • Unit Test template based on Nimble
  • Example App template
  • Swift 2.0 syntax
  • Manage dependencies with Carthage
  • Support distribution via CocoaPods and Carthage
  • MIT License
  • Test suites to cover distributions and fundamentals with make test
  • Scripts for working on CLI and CI integration
  • Optional Travis CI integration
  • Optional Apple Development Certification provisioning

Getting Started

To install the latest stable version of generator-swift-framework from npm, run:

npm install -g generator-swift-framework

Make a new directory for the framework, and cd into it:

mkdir my-new-framework && cd $_

Then, initiate the generator via Yeoman:

yo swift-framework

generator-swift-framework is actually a Yeoman Generator.

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

Contributions

To install the development branch

npm install -g github:cybertk/generator-swift-framework#branch/name

See Contribution Guide for more details.

License

generator-swift-framework is available under the MIT license.