Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pmairoldi/framework-generate

Simple tool to help generate Xcode framework projects for all targets at once
https://github.com/pmairoldi/framework-generate

xcode

Last synced: about 1 month ago
JSON representation

Simple tool to help generate Xcode framework projects for all targets at once

Host: GitHub
URL: https://github.com/pmairoldi/framework-generate
Owner: pmairoldi
License: mit
Created: 2017-01-17T03:52:00.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2018-02-09T03:07:48.000Z (almost 7 years ago)
Last Synced: 2024-12-21T03:48:54.514Z (about 1 month ago)
Topics: xcode
Language: Ruby
Size: 85.9 KB
Stars: 15
Watchers: 4
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# framework-generate
[![Gem Version](https://badge.fury.io/rb/framework-generate.svg)](https://badge.fury.io/rb/framework-generate)
[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)

Simple tool to help generate a [multiplatform, single-scheme Xcode project](http://promisekit.org/news/2016/08/Multiplatform-Single-Scheme-Xcode-Projects/).

## Installation

Add this line to your Gemfile:

```rb
gem 'framework-generate'
```

## Usage

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

```bash
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`](docs/FrameworkSpec) folder of this repoisitory.

To view the full `FrameworkSpec` documentation see the [`docs`](docs/FrameworkSpec.md) folder.

### Sample FrameworkSpec Files

Don't know where to start? Some FrameworkSpec files exist [here](https://github.com/petester42/framework-specs) 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](CODE_OF_CONDUCT.md).

### How to contribute

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

```bash
[sudo] gem install bundler
```

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

```bash
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](LICENSE) file.