About

BMKit is a collection of well documented Objective-C classes and categories for iOS (and Mac) development that make life easier by solving common problems in iOS (and Mac) development. Right now BMKit is a static library for iOS 4.0 and beyond.

Documentation

Documentation is done using AppleDoc. The generated API documentation is available online.

License

BMKit is licensed under the Simplified BSD License. See the LICENSE file for details.

Installation

Run the following command to add BMKit as a Git submodule to your project. Be sure you have are you in the root folder of your project.

$ git submodule add git://github.com/bmeurer/BMKit.git Vendor/BMKit

If you don't want to add BMKit as a submodule to your project or if your project is not managed using Git, then you can run the following commands to download the source code of the most recent revision.

$ mkdir -p Vendor/BMKit
$ curl -L http://github.com/bmeurer/BMKit/tarball/master | tar xz --strip 1 -C Vendor/BMKit

Adding to your Project

• In Xcode, add the BMKit.xcodeproj to your project.
• In the Build Phases of a target, add libBMKit.a to the Target Dependencies and Link Binary with Libraries.
• In the build phases of a target, add the ImageIO.framework, MobileCoreServices.framework and SystemConfiguration.framework frameworks. to the Link Binary with Libraries.
• Choose the Build Settings tab. Make sure All is selected in the top left of the bar under the tabs.
• Add Vendor/BMKit to the Header Search Path (do not click the Recursive checkbox).
• Add -all_load -ObjC to Other Linker Flags.

Usage

To use BMKit, simply add the following line to your source file. I recommend adding this to your prefix to make things easy.

#import <BMKit/BMKit.h>

You can also import individual files instead of the whole framework by doing something like:

#import <BMKit/BMNetworkReachabilityController.h>

Bug Reports

If you come across any problems, please create a ticket and we will try to get it fixed as soon as possible.

Contributing

Once you've made your commits:

1. Fork BMKit.
2. Create a topic branch - git checkout -b my_branch.
3. Push to your topic branch - git push origin my_branch.
4. Create a Pull Request from your topic branch.
5. That's it!

Authors

Benedikt Meurer :: benedikt.meurer@googlemail.com :: @bmeurer

Copyright

Copyright (c) 2004-2011 Benedikt Meurer. See the License file for details.