MUKObjectCache
MUKObjectCache is a simple, block-based, ARC-enabled, iOS 4+ library built to provide you an in-memory, file cache solution.
Requirements
- ARC enabled compiler
- Deployment target: iOS 4 or greater
- Base SDK: iOS 5 or greater
- Xcode 4 or greater
Installation
Thanks to jverkoey iOS Framework.
Step 0: clone project from GitHub recursively, in order to get also submodules
git clone --recursive git://github.com/muccy/MUKObjectCache.git
Step 1: add MUKObjectCache to your project
Drag or Add To Files... MUKObjectCache.xcodeproj
to your project.
Please remember not to create a copy of files while adding project: you only need a reference to it.
Now add MUKToolkit.xcodeproj
by choosing that project from Submodules/MUKToolkit
. With this step you are adding MUKObjectCache
dependencies. If your project already contains dependencies please take care to use updated libraries.
Step 2: make your project dependent
Click on your project and, then, your app target:
Add dependency clicking on + button in Target Dependencies pane and choosing static library target (MUKObjectCache
) and its dependency (MUKToolkit
):
Link your project clicking on + button in Link binary with Libraries pane and choosing static library product (libMUKObjectCache.a
). Link also submodule dependency (libMUKToolkit.a
):
Step 3: link required frameworks
You need to link those framework in order to support MUKToolkit
dependency:
Foundation
UIKit
CoreGraphics
Security
To do so you only need to click on + button in Link binary with Libraries pane and you can choose them. Tipically you only need to add Security
:
Step 4: load categories
In order to load every method in MUKToolkit
dependency you need to insert -ObjC
flag to Other Linker Flags
in Build Settings of your project.
Step 5: import headers
You only need to write #import <MUKObjectCache/MUKObjectCache.h>
when you need headers.
You can also import MUKObjectCache
headers in your pch
file:
Documentation
Build MUKObjectCacheDocumentation
target in order to install documentation in Xcode.
Requirement: appledoc awesome project.
TODO: online documentation.
License
Copyright (c) 2012, Marco Muccinelli All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.