Link from main README.md to build for iOS/OSX and Windows

1 files changed, 29 insertions, 0 deletions

diff --git a/build-mac/README.md b/build-mac/README.md
new file mode 100644
index 00000000..5e1c647c
--- /dev/null
+++ b/build-mac/README.md
@@ -0,0 +1,29 @@
+### Build for iOS/OSX ###
+
+1. If you're migrating from MailCore1, you should first clean your build folder.
+2. Checkout MailCore2 into a directory relative to your project.
+3. Under the `build-mac` directory, locate the `mailcore2.xcodeproj` file, and drag this into your Xcode project.
+4. **For Mac** - If you're building for Mac, you can either link against MailCore 2 as a framework, or as a static library:
+    * Mac framework
+        - Go to Build Phases from your build target, and under 'Link Binary With Libraries', add `MailCore.framework` and `Security.framework`.
+        - Make sure to use LLVM C++ standard library.  Open Build Settings, scroll down to 'C++ Standard Library', and select `libc++`.
+        - In Build Phases, add a Target Dependency of `mailcore osx` (it's the one with a little toolbox icon).
+        - Goto `Editor > Add Build Phase > Copy Files`.
+        - Expand the newly created Build Phase and change it's destination to "Frameworks".
+        - Click the `+` icon and select `MailCore.framework`.
+    * Mac static library
+        - Go to Build Phases from your build target, and under 'Link Binary With Libraries', add `libMailCore.a` and `Security.framework`.
+        - Set 'Other Linker Flags' under Build Settings: `-luchardet -lctemplate -letpan -lxml2 -lsasl2 -liconv -ltidy -lz` `-lc++ -stdlib=libc++ -ObjC -lcrypto -lssl`
+        - Make sure to use LLVM C++ standard library.  In Build Settings, locate 'C++ Standard Library', and select `libc++`.
+        - In Build Phases, add a Target Dependency of `static mailcore2 osx`.
+5. **For iOS** - If you're targeting iOS, you have to link against MailCore 2 as a static library:
+    * Add `libMailCore-ios.a`
+    * Add `CFNetwork.framework`
+	* Add `Security.framework`
+    * Set 'Other Linker Flags': `-luchardet-ios -lctemplate-ios -letpan-ios -lxml2 -lsasl2 -liconv -ltidy -lz` `-lc++ -stdlib=libc++ -ObjC`
+    * Make sure to use LLVM C++ standard library.  Open Build Settings, scroll down to 'C++ Standard Library', and select `libc++`.
+    * In Build Phases, add a Target Dependency of `static mailcore2 ios`.
+6. Profit.
+
+Here's a video that shows all the steps for iOS:
+http://www.youtube.com/watch?v=9fAo6oBzlQI