src/adium/README.Adium

   1 Compiling SIPE plugin for Adium
   2 ===============================
   3
   4 To compile the Adium plugin you will need Xcode and the source code from
   5 the following URLs:
   6
   7 - Adium 1.5+:      http://trac.adium.im/wiki/GettingNewestAdiumSource
   8 - OpenSSL 0.9.8za: https://www.openssl.org/source/old/0.9.x/openssl-0.9.8za.tar.gz
   9 - SIPE:            http://sourceforge.net/projects/sipe/files/sipe/
  10
  11
  12 1. Get Adium
  13 ------------
  14
  15 NOTE: you only have to do this step once. If you don't change the Adium
  16       source code, then you can reuse the results from this step in future
  17       SIPEAdiumPlugin builds.
  18
  19 Follow the instructions at their URL above.
  20
  21 The directory needs to be called "adium" and must be located at the same
  22 level as the SIPE source code directory.
  23
  24
  25 2. Get OpenSSL
  26 --------------
  27
  28 NOTE: you only have to do this step once. If you don't change the OpenSSL
  29       source code, then you can reuse the results from this step in future
  30       SIPEAdiumPlugin builds.
  31
  32 Execute the following commands in the Terminal application to download and
  33 unpack the source code:
  34
  35     $ cd my_working_directory
  36     $ curl -o openssl-0.9.8za.tar.gz https://www.openssl.org/source/old/0.9.x/openssl-0.9.8za.tar.gz
  37     $ tar -xf openssl-0.9.8za.tar.gz
  38
  39 The directory needs to be called "openssl-0.9.8za" and must be located at
  40 the same level as the SIPE source code directory.
  41
  42
  43 3. Build the SIPEAdiumPlugin Xcode project
  44 ------------------------------------------
  45
  46 In Xcode go to the menu File -> Open..., browse to the location of your SIPE
  47 source tree, go into the src/adium directory, select SIPEAdiumPlugin.xcodeproj
  48 and press "Open".
  49
  50 NOTE: please always make sure that the correct scheme has been selected by
  51       selecting the menu Product -> Scheme -> SIPEAdiumPlugin. Otherwise you
  52       will get cryptic build failures.
  53
  54 Now you can just select Product -> Build and after a short while you should
  55 get a SIPEAdiumPlugin binary that you can install into your Adium application.
  56
  57
  58 4. Generate & verify the release archive
  59 ----------------------------------------
  60
  61 The build copies the files into your Adium plugin directory. Use the following
  62 commands to generate the release archive:
  63
  64     $ cd ~/Library/Application\ Support/Adium\ 2.0/PlugIns
  65     $ zip -r ~/SIPEAdiumPlugin.zip SIPEAdiumPlugin.AdiumLibpurplePlugin/
  66
  67 You need to have a bash 4 to run the verification script, e.g. on a Linux box
  68
  69     $ src/adium/check_release.sh ~/SIPEAdiumPlugin.zip
  70
  71
  72 5. Build SIPEAdiumPlugin for an older Max OS X release
  73 ------------------------------------------------------
  74
  75 If your Xcode does not have the SDK for the older Mac OS X release then please
  76 see
  77
  78     https://github.com/devernay/xcodelegacy
  79
  80 how to extract & install SDKs for
  81
  82     - OS X 10.9 & 10.10 from the Xcode 6.4 installation package
  83     - OS X 10.11 from the Xcode 7.3.1 installation package
  84
  85 Installing all SDKs in one go seems to break Xcode builds, so please make sure
  86 to install each SDK separately with
  87
  88     $ sudo ./XcodeLegacy.sh -osxXXXX install
  89
  90 Xcode no longer seems to apply project build settings top-down. To make
  91 changes please
  92
  93     - select the SIPEAdiumPlugin or Adium project
  94     - select the "Build Settings" tab
  95     - change from "Basic" to "All" (on the left)
  96     - change from "Combined" to "Levels" (in the middle)
  97     - find the line with the setting you want to change (use search field)
  98     - select that line
  99     - change the setting at the right-most(!) place in that line
 100     - you will notice that all places to the left change automatically
 101
 102 Settings to change
 103
 104     SDK to    |  Base SDK  | Implicitly Link Objective-C  | Other
 105     build for |            | Runtime Support (Adium only) |
 106    -----------|------------|------------------------------|-------------------
 107      10.11    | OS X 10.11 |    <No change necessary>     |
 108      10.10    | OS X 10.10 |    <No change necessary>     | Adium <= 1.5.10.3
 109      10.9     | OS X 10.9  |            No                | Adium <= 1.5.10.3
 110
 111
 112 6. Alternative build approach
 113 -----------------------------
 114
 115 The default build approach also builds Adium which is actually unnecessary to
 116 build the plugin successfully. All what is needed are the compiled frameworks
 117 from an Adium build. This section describes the modifications in the sections
 118 above to build the plugin without Adium.
 119
 120 NOTE: this approach can't run the plugin, hence you won't be able to debug
 121       it. To execute the plugin you will need to run Adium by hand, e.g. from
 122       your normal Adium installation on the desktop.
 123
 124 Section 1:
 125
 126     - after getting the Adium source code open Xcode and go to the menu
 127       File -> Open...
 128     - browse to the location of your Adium source tree, select Adium.xcodeproj
 129       and press "Open"
 130     - optional: go to the menu Product -> Clean, if you want to clean up the
 131       artifacts from an earlier build to run a clean build from scratch
 132     - go to the menu Product -> Build to run the Adium build
 133     - after it is done go to the menu File -> Close Project
 134
 135 As long as you don't change the Adium source you can re-use the output from
 136 this Adium build for all future plugin builds.
 137
 138 Section 3:
 139
 140     - after opening the project select the Adium sub-project
 141     - select "Delete" from the context menu
 142     - press "Remove Reference" in the dialog
 143     - go to the menu Product -> Build to run the plugin build
 144
 145 This build is considerably faster and can help to speed up the development
 146 cycle.
 147
 148 NOTE: do *NEVER* check-in the modified SIPEAdiumPlugin.xcodeproj directory
 149       from this approach. All real changes to the build must be done using
 150       the default build approach!
 151
 152 To revert to the default build approach:
 153
 154     - go to the menu Product -> Clean to remove the build artifacts of the
 155       plugin build
 156     - go to the menu File -> Close Project to close the project
 157     - execute the following git commands to revert the plugin source tree:
 158
 159       $ git clean -xfd
 160       $ git checkout HEAD -- src/adium/SIPEAdiumPlugin.xcodeproj/
 161
 162 Now you can perform the default build again as described in section 3.