Skip to content

Instantly share code, notes, and snippets.

@nevyn

nevyn/CONTRIBUTING.md

Created April 17, 2014 09:12
Show Gist options
  • Save nevyn/10967370 to your computer and use it in GitHub Desktop.
Save nevyn/10967370 to your computer and use it in GitHub Desktop.
Download ZIP
some cocoapods docs I wrote until I noticed that http://guides.cocoapods.org/contributing/dev-environment.html already exists
Raw
CONTRIBUTING.md

Working with the CocoaPods code base

In case you're unusued to working with Ruby projects or the used build tools, this section explains some work flows that will help you work with the CocoaPods code base.

CocoaPods uses Bundler to manage its dependencies. After checking out the CocoaPods repository, run rake bootstrap (which runs bundler install and git submodule update --init --recursive) to install everything you need to run and work on CocoaPods.

Working on CocoaPods dependencies or subprojects

CocoaPods is split into three: This main project which builds a complete tool, CocoaPodsCore which contains the data model and file parsers, and Xcodeproj which modifies and creates Xcode project and workspace files. For some changes, you are likely to need to make changes to either of those, in addition to the main project. You can tell Bundler that you want to use your local checkout of either of these projects instead of the system-wide installed version when you run the main project's "pod" tool.

For example, you might have the main project checked out as ~/Dev/CocoaPods and core checked out as ~/Dev/CocoaPodsCore. You can tell Bundler to use your version of Core by running:

bundle config local.cocoapods-core ~/Dev/CocoaPodsCore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment