# HG changeset patch
# User Sebastien Decugis <sdecugis@freediameter.net>
# Date 1351626802 -3600
# Node ID 03d5a7892f2a1117b6450b707a5d413121201c01
# Parent  e457e7ac3a6d88ac04c19b03eb6f3473f6dbe214
Improved instructions for Mac OS X

diff -r e457e7ac3a6d -r 03d5a7892f2a INSTALL.OSX
--- a/INSTALL.OSX	Tue Oct 30 20:46:49 2012 +0100
+++ b/INSTALL.OSX	Tue Oct 30 20:53:22 2012 +0100
@@ -4,43 +4,77 @@
 QUICK INSTRUCTIONS
 ------------------
 
-1) Install Homebrew
+Starting from version 1.1.5, freeDiameter is available through Homebrew:
 
-   ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
+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) Starting from version 1.1.5, a brew is available for freeDiameter: 
+2) Install freeDiameter 
+     $ brew install freediameter-server
+
+   After installation is done "Cavets" section will provide information 
+   how to start freeDiameterd through launchd at system startup.
 
-   brew install freediameter-server
+   To view this information again: 
+     $ brew cavets freediameter-server
 
+   To learn more about freeDiameter configuration option, 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) Dependencies
- a) install Xcode from App Store
- b) install homebrew (might require to re-install perl and git also)
- c) brew install the following packages:
-   cmake mercurial gnutls mysql postgresql libidn
+1) Install Homebrew:
+   See QUICK INSTRUCTION Step #1 above.
+
+2) Install Dependencies
+    $ brew install mercurial cmake gnutls postgres mysql libidn
+
+   Note: GNU IDN (libidn) is optional, see bellow
 
-2) Retrieve source folder
- hg clone http://www.freediameter.net/hg/freeDiameter
+3) Retrieve Source
+    $ hg clone http://www.freediameter.net/hg/freeDiameter
+
+4) Enter Source Folder:
+    $ cd freeDiameter
 
-3) Configure your build -- execute from your build folder
- ccmake /path/to/freeDiameter/sources
+5) Create Build Folder:
+    $ mkdir freeDiameter-build
+
+6) Enter build folder:
+    $ cd freeDiameter-build
 
- (you have to disable SCTP at the moment, before initial configuration)
-Example:
-  mkdir freeDiameter-build
-  cd freeDiameter-build
-  ccmake -DDISABLE_SCTP:BOOL=ON /path/to/freeDiameter/sources
-  /* Select 'c' then choose your options, then 'c' again and 'g' */
-  make
+7) Configure
+    $ cmake .. -DDISABLE_SCTP:BOOL=ON
+   or for ncurses based configuration:
+    $ ccmake .. -DDISABLE_SCTP:BOOL=ON
+
+   Notes:
+   * SCTP is not currently supported on OS X platform
+   * 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
 
-4) make
+8) Compile
+    $ make
 
-/* note: on my system I have to make a second time for compilation to complete, it seems something is wrong with swig processing order */
+9) Install
+    # make install
 
-These instructions have been tested on Mac OS X 10.6.8 (Snow Leopard). 
-They should work smoothly on more recent versions as well.
+------------------------------------------------
 
+These instructions have been tested on OS X:
+   - 10.6.8 (Snow Leopard)
+   - 10.7.5 (Lion)
+   - 10.8.2 (Mountain Lion)