Initial commit
Change-Id: I6a4444e3c193dae437cd7929f4c39aba7b749efa
diff --git a/INSTALL.OSX b/INSTALL.OSX
new file mode 100644
index 0000000..1e6dc65
--- /dev/null
+++ b/INSTALL.OSX
@@ -0,0 +1,85 @@
+See INSTALL file for general instructions on building freeDiameter.
+
+------------------
+QUICK INSTRUCTIONS
+------------------
+
+Starting from version 1.1.5, freeDiameter is available through Homebrew:
+
+1) Install Homebrew
+ a) Install Command Line Tools for Xcode or Xcode:
+ - Command Line Tools (your OS X Version) for Xcode:
+ https://developer.apple.com/downloads (Free Apple Developer ID Registration Required)
+ - or Xcode:
+ https://itunes.apple.com/us/app/xcode/id497799835 (Free App Store Account Required)
+
+ b) Install Homebrew
+ $ ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
+
+2) Install freeDiameter:
+ $ brew install freediameter
+
+ After installation is done "Caveats" section will provide information
+ how to start freeDiameterd through launchd at system startup.
+
+ To view this information again:
+ $ brew info freediameter
+
+ To learn more about freeDiameter configuration options, read:
+ http://www.freediameter.net/trac/wiki/Configuration
+
+ For more information on available extension and how to configure them, read:
+ http://www.freediameter.net/trac/wiki/Extensions
+
+------------
+FROM SOURCES
+------------
+
+1) Install Homebrew:
+ See QUICK INSTRUCTIONS Step #1 above.
+
+2) Install dependencies:
+ $ brew install mercurial cmake gnutls libgcrypt postgres mysql libidn
+
+ Notes:
+ * GNU IDN (libidn) is optional, see below
+ * When libusrsctp package is available, you can use it as well.
+ However, it requires some rework on the source code as libusrsctp is not fully
+ compliant with the other SCTP stack.
+
+3) Retrieve source code:
+ $ hg clone http://www.freediameter.net/hg/freeDiameter
+
+4) Enter source folder:
+ $ cd freeDiameter
+
+5) Create build folder:
+ $ mkdir freeDiameter-build
+
+6) Enter build folder:
+ $ cd freeDiameter-build
+
+7) Configure:
+ $ cmake .. -DDISABLE_SCTP:BOOL=ON
+
+ or for ncurses-based configuration:
+ $ ccmake .. -DDISABLE_SCTP:BOOL=ON
+
+ Notes:
+ * GNU IDN (Support for International Domain Names) can be disabled with:
+ -DDIAMID_IDNA_IGNORE=ON or -DDIAMID_IDNA_REJECT=ON
+ * For more information on available configuration options, read:
+ http://www.freediameter.net/trac/wiki/Installation
+
+8) Compile:
+ $ make
+
+9) Install (might require to be root):
+ $ make install
+
+------------------------------------------------
+
+These instructions have been tested on OS X:
+ - 10.6.8 (Snow Leopard)
+ - 10.7.5 (Lion)
+ - 10.8.2 (Mountain Lion)