alemar11 / Mechanica

Mechanica

A library of Swift utils to ease your iOS, macOS, watchOS, tvOS and Linux development.

• Requirements
• Documentation
• Installation
• License
• Contributing

Requirements

Documentation

Documentation is available online.

http://www.alessandromarzoli.com/Mechanica/

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build Mechanica 1.0.0+.

To integrate Mechanica into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Mechanica', '~> 2.2.0'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Mechanica into your Xcode project using Carthage, specify it in your Cartfile:

github "alemar11/Mechanica" ~> 2.2.0

Run carthage update to build the framework and drag the built Mechanica.framework into your Xcode project.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. Once you have your Swift package set up, adding Mechanica as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/alemar11/Mechanica.git", .upToNextMajor(from: "3.1.0"))
]

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate Mechanica into your project manually.

Embedded Framework

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

• Add Mechanica as a git submodule by running the following command:

$ git submodule add https://github.com/alemar11/Mechanica.git

• Open the new Mechanica folder, and drag the Mechanica.xcodeproj into the Project Navigator of your application's Xcode project.

  It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the Mechanica.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different Mechanica.xcodeproj folders each with two different versions of the Mechanica.framework nested inside a Products folder.

  It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom Mechanica.framework.

• Select the top Mechanica.framework for iOS and the bottom one for macOS.

  You can verify which one you selected by inspecting the build log for your project. The build target for Mechanica will be listed as either Mechanica iOS, Mechanica macOS, Mechanica tvOS or Mechanica watchOS.

License

Mechanica is released under the MIT license. See LICENSE for details.

Contributing

Pull requests are welcome!
Show your ❤ with a ★