framework-generate

Simple tool to help generate a multiplatform, single-scheme Xcode project.

Installation

Add this line to your Gemfile:

gem 'framework-generate'

Usage

Once installed you can run the generate command from the command line as follows

framework-generate

framework-generate will look for a FrameworkSpec file in the current folder to generate your Xcode project. An example of a FrameworkSpec can be found in the docs folder of this repoisitory.

To view the full FrameworkSpec documentation see the docs folder.

Sample FrameworkSpec Files

Don't know where to start? Some FrameworkSpec files exist here for a couple projects. It can be a good place to start!

Contributing

Love framework-generate but want to make it even better?

Open source isn't just writing code. We could use your help with any of the following:

Finding (and reporting!) bugs.
New feature suggestions.
Answering questions on issues.
Documentation improvements.
Reviewing pull requests.
Helping to manage issue priorities.
Fixing bugs/new features.

If any of that sounds cool to you, send a pull request! After a few contributions, we'll add you as an admin to the repo so you can merge pull requests and help build framework-generate.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to contribute

Contributing is easy but you will need to have bundler installed. If you don't it can be installed using:

[sudo] gem install bundler

When you have bundler installed, simply make your changes to the tool and then try it out using:

bundle install
bundle exec framework-generate

Once your change is good to go open up a pull request!

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

pmairoldi / framework-generate